adamgayoso / sphinx-automodapi

Sphinx extension for generating API documentation

Home Page:https://sphinx-automodapi.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Azure Status Coverage Status PyPI

About

This is a Sphinx extension to automatically generate API pages for whole modules. It was originally developed for the Astropy project but is now available as a standalone package since it can be used for any other package. The documentation can be found on ReadTheDocs.

Running tests

To run the tests, you can either do:

pytest sphinx_automodapi

or if you have tox installed:

tox -e test

About

Sphinx extension for generating API documentation

https://sphinx-automodapi.readthedocs.io

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Python 100.0%