sphinx-autoapi

Generating API documentation with static analysis

mypackage/

├── docs

│ ├── conf.py

│ └── index.rst

├── mypackage

│ ├── __init__.py

│ ├── _client.py

│ └── _server.py

└── README.md

​

# conf.py

extensions = [

“sphinx.ext.viewcode”,

...,

“autoapi.extension”,

]

autoapi_dirs = [“../mypackage/”]

​

​

# Auto-discover members

.. autoapiclass:: mypackage.Server

:members:

​

# Or manually specify members

.. autoapiclass:: mypackage.Post

​

.. autoapiclass:: mypackage.Client

​

.. autoapimethod:: get_all()

​

.. autoapimethod:: get(post_id)

sphinx-autoapi

Generating API documentation with static analysis