I decided to document my Django projects with the same tool used by Django team: Sphinx. It is a very good documenting tool, and was used for many other projects, including the Python Project itself.
But it has a simple problem with Django, that I found the solution rlazo’s blog. But it still has some problems, when you are trying to document a pluggable app, that doesn’t have a project, you have to configure the django settings without the project settings, since pluggable apps doesn’t have a settings module.
Thanks to apollo13, who shown me this better approach, you can simply add this code to sphinx’s conf.py file:
from django.conf import settings settings.configure()
With this approach, you don’t need to add any kind of fake files in your project.
March 19th, 2009 12:27
@apollo13 Thanks for the reply, I took a look at you link and found out that your solution is really more beaty than mine. I will fix the POST to use this new approach.