Showing Tag: " python" (Show all posts)

Setting up Sphinx documenter with a Django project - a quickstart tutorial

Posted by Christo Crampton on Tuesday, November 17, 2009, In : Python

Sphinx documenter is quite a nice tool for creating pseudo-auto-documented documentation from your source code. I had a little trouble setting it up, and found that there is fairly poor documentation on the web (a little strange for a documentation tool...). Here's what I did.

1.) Setting it up:

this part is quite easy, just go through the 'getting started' tutorial here

This will create your basic documentation project. You should have a file layout something like this: