You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
80 lines
1.8 KiB
ReStructuredText
80 lines
1.8 KiB
ReStructuredText
Sphinx AutoAPI
|
|
==============
|
|
|
|
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 some manual authoring and uses code imports,
|
|
AutoAPI finds and generates documentation by parsing source code.
|
|
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Beginner Guides
|
|
|
|
New to AutoAPI? Check out the Tutorials.
|
|
They are a hands-on introduction for beginners.
|
|
|
|
+++
|
|
|
|
.. button-ref:: tutorials
|
|
:expand:
|
|
:color: secondary
|
|
:click-parent:
|
|
|
|
To the beginner guides
|
|
|
|
.. grid-item-card:: User Guides
|
|
|
|
The user guides are recipes for key tasks and common problems.
|
|
|
|
+++
|
|
|
|
.. button-ref:: how_to
|
|
:expand:
|
|
:color: secondary
|
|
:click-parent:
|
|
|
|
To the user guides
|
|
|
|
.. grid-item-card:: Reference Guide
|
|
|
|
The reference guide contains a detailed description of the
|
|
configuration options, directives, and templates included in AutoAPI.
|
|
|
|
+++
|
|
|
|
.. button-ref:: reference/index
|
|
:expand:
|
|
:color: secondary
|
|
:click-parent:
|
|
|
|
To the reference guide
|
|
|
|
.. grid-item-card:: Contributor Guides
|
|
|
|
Want to add to the codebase?
|
|
The contributing guidelines will guide you through the
|
|
process of improving AutoAPI.
|
|
|
|
+++
|
|
|
|
.. button-ref:: maintenance/index
|
|
:expand:
|
|
:color: secondary
|
|
:click-parent:
|
|
|
|
To the contributor guides
|
|
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
tutorials
|
|
how_to
|
|
reference/index
|
|
maintenance/index
|