I have a project with several large apps and where settings and apps files are split.
directory structure goes something like that:
project_name
every app is like that
How to use a Sphinx to autogenerate documentation for that?
I want something like that for each in settings module or INSTALLED_APPS (not starting with django.* or 3rdparty.*) give me a auto documentation output based on docstring.
And autogen documentation and run tests before git commit
btw. I tried doing .rst files by hand with
.. automodule:: module_name
:members:
but is sucks for such a big project, and it does not works for settings
Is there an autogen method or something?
I am not tied to Sphinx, is there a better solution for my problem?
See Automatically Generating Documentation for All Python Package Contents.
The upcoming Sphinx 1.1 release includes a sphinx-apidoc.py script.