April 2009 Archives


| No Comments | No TrackBacks
Sphinx: Python Documentation Builder

We have a weekly show-n-tell at work and this came up for one of the presentations.
Sphinx uses restructured text (ReST) to generate and build documentation in a variety of formats.

Some cool things about it are how it handles python code examples.
It will actually run/test code using docstring tests during the build process to ensure that you are including examples that actually work!

It also uses Pygments: Python Syntax Highlighter to give all of your code snips that professional look.

The build process will generate HTML, Latex to PDF and a bunch of other such portable/publishable type formats.

I am going to experiment with redesigning my resume/portfolio site with it.
I thought this might be usesfull for this process considering a lot of my projects that I would like to highlight on my resume site are very technical and require technical documentation.

Here are some example sites that use sphinx:

SQL Alchemy
Pysparse v1.0.2 documentations
Pyevolve documentation

There is a more comprehensive list available on at the sphinx site.  The links above are some of the more unique designs that I picked out as examples.

About this Archive

This page is an archive of entries from April 2009 listed from newest to oldest.

March 2009 is the previous archive.

May 2009 is the next archive.

Find recent content on the main index or look in the archives to find all content.


Powered by Movable Type 4.23-en