Beautiful Python documentation using Sphinx

Writing documentation does not have to be a pain and I think Sphinx is a pretty useful tool for creating kick ass documentation.

To get a feel of how Sphinx looks like, take a look at where it's used:

• Python 2.6: Sphinx is used to document Python 2.6 (and the upcoming Python versions)
• Django: Sphinx is also used to document Django
• and a lot of other Python projects

What features does it support?

• Easy to use markup system (based on reStructuredText)
• Highly customizable
• Really good support for Python
• Export to HTML, LaTeX, PDF (and other formats)
• Cross-references, code highlighting, hierarchical structure and more...

To get started using Sphinx, simply do following:

sudo easy_install sphinx
sphinx-quickstart

After running sphinx-quickstart you got documentation directories and bam, you can explore Sphinx in greater detail ;-)

Sphinx itself has excellent documentation and I recommend reading it through to get a better feeling about Sphinxes features.

• Visit Sphinx documentation

Now I am off to making some more documentation.