echelon


Sphinx Cheatsheet

I find myself working with the Sphinx Documentation Generator a lot recently. It is a great tool to easily create intelligent and beautiful documentation and it is based on reStructuredText. I put together a cheat sheet of all the commands I frequently use. There are a number of very good ones out there ([1] [2] [3] [4]) but I find it more convenient to work with my own.

You can access the PDF from here and the source (OpenOffice Writer document) here. If you find it useful or would like an item added, feel free to leave a comment.



2 Comments

#1 Georg wrote on March 7, 2010:

Hi,

nice cheat sheet! One nit: you’re missing a space in the index directive.

Georg

#2 Sebastian Schaetz wrote on March 7, 2010:

Georg,
thanks for your comment.
you are of course correct. I fixed this right away :-)

Sorry, the comment form is closed at this time.