Sphinx AutoAPI
==============
.. image:: https://readthedocs.org/projects/sphinx-autoapi/badge/?version=latest
:target: https://sphinx-autoapi.readthedocs.org
:alt: Documentation
.. image:: https://github.com/readthedocs/sphinx-autoapi/actions/workflows/main.yml/badge.svg?branch=main
:target: https://github.com/readthedocs/sphinx-autoapi/actions/workflows/main.yml?query=branch%3Amain
:alt: Github Build Status
.. image:: https://img.shields.io/pypi/v/sphinx-autoapi.svg
:target: https://pypi.org/project/sphinx-autoapi/
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/sphinx-autoapi.svg
:target: https://pypi.org/project/sphinx-autoapi/
:alt: Supported Python Versions
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/python/black
:alt: Formatted with Black
Sphinx AutoAPI is a Sphinx extension for generating complete API documentation
without needing to load, run, or import the project being documented.
In contrast to the traditional `Sphinx autodoc <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_,
which requires manual authoring and uses code imports,
AutoAPI finds and generates documentation by parsing source code.
Getting Started
---------------
The following steps will walk through how to add AutoAPI to an existing Sphinx project.
For instructions on how to set up a Sphinx project,
see Sphinx's documentation on
`Getting Started <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
Installation
~~~~~~~~~~~~
AutoAPI can be installed through pip:
.. code-block:: bash
pip install sphinx-autoapi
Next, add and configure AutoAPI in your Sphinx project's `conf.py`.
.. code-block:: python
extensions.append('autoapi.extension')
autoapi_dirs = ['path/to/source/files', 'src']
When the documentation is built,
AutoAPI will now generate API documentation into an `autoapi/` directory
and add an entry to the documentation in your top level table of contents!
To configure AutoAPI behaviour further,
see the `Configuration documentation <https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html>`_.
Contributing
------------
Running the tests
~~~~~~~~~~~~~~~~~
Tests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.
.. code-block:: bash
tox
Code Style
~~~~~~~~~~
Code is formatted using `black <https://github.com/python/black>`_.
You can check your formatting using black's check mode:
.. code-block:: bash
tox -e formatting
You can also get black to format your changes for you:
.. code-block:: bash
black autoapi/ tests/
You can even get black to format changes automatically when you commit using `pre-commit <https://pre-commit.com/>`_:
.. code-block:: bash
pip install pre-commit
pre-commit install
Release Notes
~~~~~~~~~~~~~
Release notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.
When making a pull request you will need to create a news fragment to document your change:
.. code-block:: bash
tox -e release_notes -- create --help
Versioning
----------
We use `SemVer <https://semver.org/>`_ for versioning. For the versions available, see the `tags on this repository <https://github.com/readthedocs/sphinx-autoapi/tags>`_.
License
-------
This project is licensed under the MIT License.
See the `LICENSE.rst <LICENSE.rst>`_ file for details.
Raw data
{
"_id": null,
"home_page": "http://github.com/readthedocs/sphinx-autoapi",
"name": "sphinx-autoapi",
"maintainer": "Ashley Whetter",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "ashley@awhetter.co.uk",
"keywords": "",
"author": "Eric Holscher",
"author_email": "eric@ericholscher.com",
"download_url": "https://files.pythonhosted.org/packages/33/48/cf3538dda02ec6f62013f9baa01b11e6049a120e67fec159d79c028d341d/sphinx-autoapi-3.0.0.tar.gz",
"platform": null,
"description": "Sphinx AutoAPI\n==============\n\n.. image:: https://readthedocs.org/projects/sphinx-autoapi/badge/?version=latest\n :target: https://sphinx-autoapi.readthedocs.org\n :alt: Documentation\n\n.. image:: https://github.com/readthedocs/sphinx-autoapi/actions/workflows/main.yml/badge.svg?branch=main\n :target: https://github.com/readthedocs/sphinx-autoapi/actions/workflows/main.yml?query=branch%3Amain\n :alt: Github Build Status\n\n.. image:: https://img.shields.io/pypi/v/sphinx-autoapi.svg\n :target: https://pypi.org/project/sphinx-autoapi/\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/sphinx-autoapi.svg\n :target: https://pypi.org/project/sphinx-autoapi/\n :alt: Supported Python Versions\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/python/black\n :alt: Formatted with Black\n\nSphinx AutoAPI is a Sphinx extension for generating complete API documentation\nwithout needing to load, run, or import the project being documented.\n\nIn contrast to the traditional `Sphinx autodoc <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_,\nwhich requires manual authoring and uses code imports,\nAutoAPI finds and generates documentation by parsing source code.\n\nGetting Started\n---------------\n\nThe following steps will walk through how to add AutoAPI to an existing Sphinx project.\nFor instructions on how to set up a Sphinx project,\nsee Sphinx's documentation on\n`Getting Started <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.\n\nInstallation\n~~~~~~~~~~~~\n\nAutoAPI can be installed through pip:\n\n.. code-block:: bash\n\n pip install sphinx-autoapi\n\nNext, add and configure AutoAPI in your Sphinx project's `conf.py`.\n\n.. code-block:: python\n\n extensions.append('autoapi.extension')\n\n autoapi_dirs = ['path/to/source/files', 'src']\n\nWhen the documentation is built,\nAutoAPI will now generate API documentation into an `autoapi/` directory\nand add an entry to the documentation in your top level table of contents!\n\nTo configure AutoAPI behaviour further,\nsee the `Configuration documentation <https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html>`_.\n\n\nContributing\n------------\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nTests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.\n\n.. code-block:: bash\n\n tox\n\nCode Style\n~~~~~~~~~~\n\nCode is formatted using `black <https://github.com/python/black>`_.\n\nYou can check your formatting using black's check mode:\n\n.. code-block:: bash\n\n tox -e formatting\n\nYou can also get black to format your changes for you:\n\n.. code-block:: bash\n\n black autoapi/ tests/\n\nYou can even get black to format changes automatically when you commit using `pre-commit <https://pre-commit.com/>`_:\n\n\n.. code-block:: bash\n\n pip install pre-commit\n pre-commit install\n\nRelease Notes\n~~~~~~~~~~~~~\n\nRelease notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.\nWhen making a pull request you will need to create a news fragment to document your change:\n\n.. code-block:: bash\n\n tox -e release_notes -- create --help\n\nVersioning\n----------\n\nWe use `SemVer <https://semver.org/>`_ for versioning. For the versions available, see the `tags on this repository <https://github.com/readthedocs/sphinx-autoapi/tags>`_.\n\nLicense\n-------\n\nThis project is licensed under the MIT License.\nSee the `LICENSE.rst <LICENSE.rst>`_ file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx API documentation generator",
"version": "3.0.0",
"project_urls": {
"Documentation": "https://sphinx-autoapi.readthedocs.io/en/latest/",
"Homepage": "http://github.com/readthedocs/sphinx-autoapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3f8489774c0ebcd96bec1e44e4c23ac741f74895efd5ba1da778b2984e0e3cb",
"md5": "7f24b4a62717b6d6ef3971891d266f5f",
"sha256": "ea207793cba1feff7b2ded0e29364f2995a4d157303a98603cee0ce94cea2688"
},
"downloads": -1,
"filename": "sphinx_autoapi-3.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f24b4a62717b6d6ef3971891d266f5f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 35009,
"upload_time": "2023-09-26T19:57:19",
"upload_time_iso_8601": "2023-09-26T19:57:19.469125Z",
"url": "https://files.pythonhosted.org/packages/f3/f8/489774c0ebcd96bec1e44e4c23ac741f74895efd5ba1da778b2984e0e3cb/sphinx_autoapi-3.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3348cf3538dda02ec6f62013f9baa01b11e6049a120e67fec159d79c028d341d",
"md5": "33cb45c6d2a0616faf09509073e85267",
"sha256": "09ebd674a32b44467222b0fb8a917b97c89523f20dbf05b52cb8a3f0e15714de"
},
"downloads": -1,
"filename": "sphinx-autoapi-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "33cb45c6d2a0616faf09509073e85267",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 58081,
"upload_time": "2023-09-26T19:57:21",
"upload_time_iso_8601": "2023-09-26T19:57:21.492463Z",
"url": "https://files.pythonhosted.org/packages/33/48/cf3538dda02ec6f62013f9baa01b11e6049a120e67fec159d79c028d341d/sphinx-autoapi-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 19:57:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "readthedocs",
"github_project": "sphinx-autoapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-autoapi"
}
JSON
