Tuesday, 28 September 2010

Sphinx Documentation Generator RPMs

So, thanks to the excellent work of Monty Taylor we now use a documentation generator in Drizzle!  He has added Sphinx Documentation Generator to the build system so that you can you can create documentation simply by doing:
make html
or
make epub

(yes, you can create epubs!)

There are other formats available.  Running 'make sphinx-help' will give you a full list of options available.

To use this you need to be using the latest trunk of Drizzle or the release that is due this week.  A minimum python-sphinx 1.0 also needs to be installed (older versions will work, but some output will be incorrect).  Unfortunately Ubuntu Lucid/Maverick and Fedora 13 all have Sphinx 0.6.6, so if you are running Ubuntu the Drizzle Developers PPA has 1.0 ready for you to install.  For Fedora 13 users I have built some RPMs which you can download here:

Sphinx: python-sphinx-1.0.4-1.fc13.noarch.rpm
Sphinx's documentation: python-sphinx-doc-1.0.4-1.fc13.noarch.rpm
Sphinx source: python-sphinx-1.0.4-1.fc13.src.rpm

Now, we just need to write the documentation!  We have several of us writing the basics right now, but as always any community help on this would be greatly appreciated.

1 comment:

Note: only a member of this blog may post a comment.