[OGRE-305] Missing instructions for building documentation

Question

[reporter="mafm", created="Tue, 15 Oct 2013 01:21:24 +0200"]

I am trying to build the Debian package for 1.9 RC2 and I am finding some inaccuracies and difficulties to build the documentation.

The instructions in BuildingOgre.txt mention "make doc", which I think that it became "make OgreDoc".

graphviz seems necessary (additionally to Doxygen) to build the documentation with graphics.

The manual and vbo-update doc can be built with the help of the script makedocs.sh (needs texi2html), but tries to build the API again with doxygen again first of all. It looks as if the API was updated to built through cmake, but the other documentation was not, or is considered obsolete.

It would be great if you can provide clear instructions so we know the best way to provide useful, accurate and up to date documentation to users.

Hope that helps.

该提问来源于开源项目：OGRECave/ogre

Answer 1

[author="masterfalcon", created="Fri, 18 Oct 2013 05:56:42 +0200"]

It depends upon what you want. If you are just looking for the API reference then make OgreDoc is enough. But if you'd like both the API reference and manual then running makedocs.sh will suffice.

I'll update the requirements in the places that you mentioned.

Internally, we use make OgreDoc when creating the SDK's and makedocs.sh to create the published documentation.