sphinx-autoapi

Homepage:

https://github.com/readthedocs/sphinx-autoapi/

Documentation:

https://sphinx-autoapi.readthedocs.io/

sphinx-autoapi provides “autodoc” style documentation for multiple programming languages without needing to load, run, or import the project being documented.

In contrast to the traditional sphinx.ext.autodoc, which is Python-only and uses code imports, AutoAPI finds and generates documentation by parsing source code.

Example

Note

This example shows the AutoAPI documentation of sphinx-notfound-page extension.

• API Reference
  • notfound
    • Submodules
      • notfound.extension
        • Module Contents
          • Classes
          • Functions
            • BaseURIError
            • html_collect_pages()
            • finalize_media()
            • doctree_resolved()
            • OrphanMetadataCollector
              • OrphanMetadataCollector.clear_doc()
              • OrphanMetadataCollector.process_doc()
            • setup()
      • notfound.utils
        • Module Contents
          • Functions
            • replace_uris()
    • Package Contents
      • version

Installation

pip install sphinx-autoapi

Configuration

# conf.py
extensions = [
    '...',
    'autoapi.extension',
]

autoapi_dirs = [
    'your-module/',
]