Review: Added html and pdf documentation generation using sphinx


Malcolm Humphreys <malcolmh...@...>
 

I have added sphinx OCIO document generation using sphinx, there are demo's of the output here:

html - http://malcolmhumphreys.github.com/OpenColorIO/
pdf - http://malcolmhumphreys.github.com/OpenColorIO/OpenColorIO.pdf

There are some still some issues with the index generation which needs to be fixed in the sphinx c++ domain.

I have only spent a little time reformatting the docs and have spent most of the energy getting all the bits together. If you want the pdf target to build you need to install pdflatex.

I chose the 'haiku' for the html this can be customised easily, see: http://sphinx.pocoo.org/latest/theming.html

Message:
Added html and pdf documentation generation using sphinx (http://sphinx.pocoo.org/)

Added ExtractRstFromSource.py which exports specially tagged comments in headers for sphinx to pickup. eg.

--snip--
//!cpp:class:: this is some super informative
// docs
class SomeClass
{
public:
//!cpp:function:: the class namespace should still get set correctly
void foobar2();
};
--snip--

Also fixed the install crud which Closes [#50]

Commit:
https://github.com/malcolmhumphreys/OpenColorIO/commit/1c7b8aab4c9daa427ecd8edb690672dbb0bee6a9

.malcolm

Join ocio-dev@lists.aswf.io to automatically receive all group messages.