estan estan - 9 months ago 54
Python Question

Customize templates for `sphinx-apidoc`

I've recently tried using sphinx-apidoc from Sphinx to help generate Sphinx specific reStructuredText from the API of a Python project.

However, the result I'm getting is:

Default look of <code>sphinx-api</code> result

Anyone know if I can customize the template

uses for its output? Specifically, I'd like to:

  • Get rid of all the "Submodules", "Subpackages" and "Module contents" headings, and

  • Have the results from docstring in my
    files appear directly under the packages, so that if I click a package name, the first thing I see is the package documentation. At the moment, this documentation is placed under the slightly weird "Module contents" heading at the very end of each package section.

The "Submodules" and "Subpackages" headings are redundant I think, since the normal headings for packages/modules is "xxx.yyy package" and "xxx.yyy.zzz module".

The structure I would like for the above small example is

  • orexplore.components package

    • orexplore.components.mbg120 module

  • orexplore.simulators package

    • orexplore.simulators.test package

      • orexplore.simulators.test.mbg120 module

    • orexplore.simulators.mbg120 module

Where clicking the packages, the first thing I'd see on the page would be the package documentation.

Or maybe even just

  • orexplore.components

    • orexplore.components.mbg120

  • orexplore.simulators

    • orexplore.simulators.test

      • orexplore.simulators.test.mbg120

  • orexplore.simulators.mbg120

if there was some way to visually distinguish packages/modules (color? emblem?) instead of the quite wordy " package" and " module".

Answer Source

The sphinx-apidoc script uses the module. I am not able to provide detailed instructions, but in order to remove headings or otherwise customize the output, you'll have to write your own version of this module. There is no other "template".

Note that if the API and module structure is stable, there is no need to run sphinx-apidoc repeatedly. You can post-process the generated rst files to your liking once and then place them under version control. See also