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.
I forked this repo for use with my proplot project and added the following features:
- Skip over public class methods that do not have their own
__doc__docstrings. This prevents inheriting and displaying documentation from external projects. - Include
__getitem__,__getattr__,__setitem__, and__setattr__in the list of builtin methods that are not ignored by the documentation generator. - Give class methods and attributes their own stub pages instead of putting all class methods and attributes on a single page.
The last change required adding new files to env.found_docs and reordering the
event hooks in automodsumm.py so that sphinx_automodapi is called before
autosummary. This way autosummary sees the new class pages and can build
the appropriate stubs. Otherwise the stubs don't get built.
To run the tests, you can either do:
pytest sphinx_automodapi
or if you have tox installed:
tox -e test
Due to the limitations of FOSS development model, the Astropy Project does not have enough bandwidth to add new features or fixes to this package beyond what is necessary for the project itself. Therefore, we apologize for any inconvenience caused by unresolved open issues and unmerged stale pull requests. If you have any questions or concerns, please contact the project via https://www.astropy.org/help . Thank you for your interest in this package!