https://github.com/astropy/sphinx-automodapi

Sphinx extension for generating API documentation
https://github.com/astropy/sphinx-automodapi

documentation python sphinx

Last synced: 1 day ago
JSON representation

Sphinx extension for generating API documentation

• Host: GitHub
• URL: https://github.com/astropy/sphinx-automodapi
• Owner: astropy
• License: bsd-3-clause
• Created: 2016-11-06T23:08:28.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T17:02:29.000Z (about 1 month ago)
• Last Synced: 2024-10-29T17:15:54.754Z (12 days ago)
• Topics: documentation, python, sphinx
• Language: Python
• Homepage: https://sphinx-automodapi.readthedocs.io
• Size: 490 KB
• Stars: 63
• Watchers: 7
• Forks: 45
• Open Issues: 52
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
|DOI| |PyPI| |Docs| |CI Status| |Coverage Status|

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

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5799977.svg

  :target: https://doi.org/10.5281/zenodo.5799977

.. |PyPI| image:: https://img.shields.io/pypi/v/sphinx-automodapi.svg

  :target: https://pypi.python.org/pypi/sphinx-automodapi

.. |Docs| image:: https://readthedocs.org/projects/sphinx-automodapi/badge/?version=latest

    :target: https://sphinx-automodapi.readthedocs.io/en/latest/?badge=latest

.. |CI Status| image:: https://github.com/astropy/sphinx-automodapi/workflows/CI/badge.svg

  :target: https://github.com/astropy/sphinx-automodapi/actions

.. |Coverage Status| image:: https://codecov.io/gh/astropy/sphinx-automodapi/branch/main/graph/badge.svg

  :target: https://codecov.io/gh/astropy/sphinx-automodapi

Development status

------------------

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!