sphinx-autoapi


Namesphinx-autoapi JSON
Version 1.8.3 PyPI version JSON
download
home_pagehttp://github.com/readthedocs/sphinx-autoapi
SummarySphinx API documentation generator
upload_time2021-08-01 01:33:58
maintainerAshley Whetter
docs_urlNone
authorEric Holscher
requires_python>=3.6
licenseMIT
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=master
    :target: https://github.com/readthedocs/sphinx-autoapi/actions/workflows/main.yml?query=branch%3Amaster
    :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 provides "autodoc" style documentation for multiple programming languages
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 is Python-only and uses code imports,
AutoAPI finds and generates documentation by parsing source code.

Language Support
----------------

==========  ======  ==========================================================
Language    Status  Parser
==========  ======  ==========================================================
Python      Stable  Custom using `astroid <https://github.com/PyCQA/astroid>`_
Go          Alpha   `godocjson <https://github.com/readthedocs/godocjson>`_
Javascript  Alpha   `jsdoc <http://usejsdoc.org/>`_
.NET        Alpha   `docfx <https://dotnet.github.io/docfx/>`_
==========  ======  ==========================================================

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`.
Other languages may require
`further configuration <https://sphinx-autoapi.readthedocs.io/en/latest/tutorials.html#setting-up-automatic-api-documentation-generation>`_:

.. code-block:: python

    extensions.append('autoapi.extension')

    autoapi_type = 'python'
    autoapi_dirs = ['path/to/source/files', 'src']

Where `autoapi_type` can be one of any of the supported languages:

==========  ================
Language    ``autoapi_type``
==========  ================
Python      ``'python'``
Go          ``'go'``
Javascript  ``'javascript'``
.NET        ``'dotnet'``
==========  ================

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

Versioning
----------

We use `SemVer <http://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.6",
    "maintainer_email": "ashley@awhetter.co.uk",
    "keywords": "",
    "author": "Eric Holscher",
    "author_email": "eric@ericholscher.com",
    "download_url": "https://files.pythonhosted.org/packages/d6/b0/265bdb34e43274455f6dc145d94408bf0992270ce1b3e6e164b69ab87dc5/sphinx-autoapi-1.8.3.tar.gz",
    "platform": "",
    "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=master\n    :target: https://github.com/readthedocs/sphinx-autoapi/actions/workflows/main.yml?query=branch%3Amaster\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 provides \"autodoc\" style documentation for multiple programming languages\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 is Python-only and uses code imports,\nAutoAPI finds and generates documentation by parsing source code.\n\nLanguage Support\n----------------\n\n==========  ======  ==========================================================\nLanguage    Status  Parser\n==========  ======  ==========================================================\nPython      Stable  Custom using `astroid <https://github.com/PyCQA/astroid>`_\nGo          Alpha   `godocjson <https://github.com/readthedocs/godocjson>`_\nJavascript  Alpha   `jsdoc <http://usejsdoc.org/>`_\n.NET        Alpha   `docfx <https://dotnet.github.io/docfx/>`_\n==========  ======  ==========================================================\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`.\nOther languages may require\n`further configuration <https://sphinx-autoapi.readthedocs.io/en/latest/tutorials.html#setting-up-automatic-api-documentation-generation>`_:\n\n.. code-block:: python\n\n    extensions.append('autoapi.extension')\n\n    autoapi_type = 'python'\n    autoapi_dirs = ['path/to/source/files', 'src']\n\nWhere `autoapi_type` can be one of any of the supported languages:\n\n==========  ================\nLanguage    ``autoapi_type``\n==========  ================\nPython      ``'python'``\nGo          ``'go'``\nJavascript  ``'javascript'``\n.NET        ``'dotnet'``\n==========  ================\n\nWhen the documentation is built,\nAutoAPI will now generate API documentation into an `autoapi/` directory and 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\nVersioning\n----------\n\nWe use `SemVer <http://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\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Sphinx API documentation generator",
    "version": "1.8.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a9a3b15d45aeac617d9a65c3ebda9584",
                "sha256": "2d0062e5da2e53cc66356302861fccc37ca8e930a7a95753692050933f11d653"
            },
            "downloads": -1,
            "filename": "sphinx_autoapi-1.8.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a9a3b15d45aeac617d9a65c3ebda9584",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.6",
            "size": 55540,
            "upload_time": "2021-08-01T01:33:42",
            "upload_time_iso_8601": "2021-08-01T01:33:42.062814Z",
            "url": "https://files.pythonhosted.org/packages/73/ab/fa39f665b5b3dd27a3cf447e4408c83fb4566d0a90802b3dfc49ccfe6703/sphinx_autoapi-1.8.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "72ae03c1bc40e488589bd90753c4bd7b",
                "sha256": "27ee224fbade3c06567a3428de710e99d8bd527d8008e838630c7f49a2d62b8b"
            },
            "downloads": -1,
            "filename": "sphinx-autoapi-1.8.3.tar.gz",
            "has_sig": false,
            "md5_digest": "72ae03c1bc40e488589bd90753c4bd7b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 42152909,
            "upload_time": "2021-08-01T01:33:58",
            "upload_time_iso_8601": "2021-08-01T01:33:58.630988Z",
            "url": "https://files.pythonhosted.org/packages/d6/b0/265bdb34e43274455f6dc145d94408bf0992270ce1b3e6e164b69ab87dc5/sphinx-autoapi-1.8.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-08-01 01:33:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "readthedocs",
    "github_project": "sphinx-autoapi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sphinx-autoapi"
}
        
Elapsed time: 0.29181s