sphinx-autoapi


Namesphinx-autoapi JSON
Version 3.6.0 PyPI version JSON
download
home_pageNone
SummarySphinx API documentation generator
upload_time2025-02-18 01:50:55
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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-ruff-000000.svg
    :target: https://docs.astral.sh/ruff/
    :alt: Formatted with Ruff

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.

For more information, see `the full documentation <https://sphinx-autoapi.readthedocs.org>`_.

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 <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 `ruff <https://docs.astral.sh/ruff>`_.

You can check your formatting using ruff format's check mode:

.. code-block:: bash

    tox -e format

You can also get ruff to format your changes for you:

.. code-block:: bash

    ruff format

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": null,
    "name": "sphinx-autoapi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Ashley Whetter <ashley@awhetter.co.uk>",
    "keywords": null,
    "author": null,
    "author_email": "Eric Holscher <eric@ericholscher.com>",
    "download_url": "https://files.pythonhosted.org/packages/7f/a8/22b379a2a75ccb881217d3d4ae56d7d35f2d1bb4c8c0c51d0253676746a1/sphinx_autoapi-3.6.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-ruff-000000.svg\n    :target: https://docs.astral.sh/ruff/\n    :alt: Formatted with Ruff\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\nFor more information, see `the full documentation <https://sphinx-autoapi.readthedocs.org>`_.\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 <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 `ruff <https://docs.astral.sh/ruff>`_.\n\nYou can check your formatting using ruff format's check mode:\n\n.. code-block:: bash\n\n    tox -e format\n\nYou can also get ruff to format your changes for you:\n\n.. code-block:: bash\n\n    ruff format\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\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Sphinx API documentation generator",
    "version": "3.6.0",
    "project_urls": {
        "Documentation": "https://sphinx-autoapi.readthedocs.io/en/latest/",
        "Homepage": "http://github.com/readthedocs/sphinx-autoapi"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "58170eda9dc80fcaf257222b506844207e71b5d59567c41bbdcca2a72da119b9",
                "md5": "db4de59a80c788f575ba02e703a80266",
                "sha256": "f3b66714493cab140b0e896d33ce7137654a16ac1edb6563edcbd47bf975f711"
            },
            "downloads": -1,
            "filename": "sphinx_autoapi-3.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db4de59a80c788f575ba02e703a80266",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 35281,
            "upload_time": "2025-02-18T01:50:52",
            "upload_time_iso_8601": "2025-02-18T01:50:52.789544Z",
            "url": "https://files.pythonhosted.org/packages/58/17/0eda9dc80fcaf257222b506844207e71b5d59567c41bbdcca2a72da119b9/sphinx_autoapi-3.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7fa822b379a2a75ccb881217d3d4ae56d7d35f2d1bb4c8c0c51d0253676746a1",
                "md5": "7433a59c93361a041190d6bc37115e0b",
                "sha256": "c685f274e41d0842ae7e199460c322c4bd7fec816ccc2da8d806094b4f64af06"
            },
            "downloads": -1,
            "filename": "sphinx_autoapi-3.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7433a59c93361a041190d6bc37115e0b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 55417,
            "upload_time": "2025-02-18T01:50:55",
            "upload_time_iso_8601": "2025-02-18T01:50:55.241909Z",
            "url": "https://files.pythonhosted.org/packages/7f/a8/22b379a2a75ccb881217d3d4ae56d7d35f2d1bb4c8c0c51d0253676746a1/sphinx_autoapi-3.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-18 01:50:55",
    "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"
}
        
Elapsed time: 0.95266s