Sphinx autodoc is not automatic enough

Posted by Cory Walker on Stack Overflow See other posts from Stack Overflow or by Cory Walker
Published on 2010-04-23T21:11:53Z Indexed on 2010/04/23 21:13 UTC
Read the original article Hit count: 276

Filed under:
|
|

I'm trying to use Sphinx to document a 5,000+ line project in Python. It has about 7 base modules. As far as I know, In order to use autodoc I need to write code like this for each file in my project:

.. automodule:: mods.set.tests
    :members:
    :show-inheritance:

This is way too tedious because I have many files. It would be much easier if I could just specify that I wanted the 'mods' module to be documented. Sphinx could then recursively go through the module and make a page for each submodule.

Is there A feature like this? If not I could write a script to make all the .rst files, but that would take up a lot of time.

© Stack Overflow or respective owner

Related posts about sphinx

Related posts about python