A Guide to Sphinx


Sphinx is documentation generator software written and used by the Python community. It is written in Python, and also used in other environments.
This guide is an introduction to using Sphinx Documentation software, to get you over that pesky software learning curve hump.
Hopefully once there, with Sphinx you will enjoy documenting your software.


The documentation of software is a nessacary evil. Well not evil, but nessacary.
Sphinx converts reStructuredText files into HTML and other formats including PDF, EPub, Texinfo and man.
Not only that, once having an understanding of Sphinx and ReStructeredText, it is very handy for creating technical documents and/or static web pages.

To use Sphinx a little reStrucuredText knowledge is required.