API documentation¶
API documentation serves as an important reference in technical documentation. Sphinx provides many approaches to writing API documentation, from writing them manually as well as automatically generating it from docstrings in your code.
This example uses sphinx.ext.autodoc
for generating the API documentation skeleton. sphinx.ext.intersphinx
provides links for classes in type annotations.
.. autoclass:: sphinx.ext.todo.TodoDomain
:members:
:noindex:
This is a small example from reStructuredText.
-
class
sphinx.ext.todo.
TodoDomain
(env: BuildEnvironment)[source] -
clear_doc
(docname: str) → None[source] Remove traces of a document in the domain-specific inventories.
-
merge_domaindata
(docnames: List[str], otherdata: Dict) → None[source] Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).
-
process_doc
(env: sphinx.environment.BuildEnvironment, docname: str, document: docutils.nodes.document) → None[source] Process a document after it is read by the environment.
-
This is a small example from reStructuredText.
```{eval-rst}
.. autoclass:: sphinx.ext.todo.TodoDomain
:members:
:noindex:
```
This is a small example from Markdown.
-
class
sphinx.ext.todo.
TodoDomain
(env: BuildEnvironment)[source] -
clear_doc
(docname: str) → None[source] Remove traces of a document in the domain-specific inventories.
-
merge_domaindata
(docnames: List[str], otherdata: Dict) → None[source] Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).
-
process_doc
(env: sphinx.environment.BuildEnvironment, docname: str, document: docutils.nodes.document) → None[source] Process a document after it is read by the environment.
-
This is a small example from Markdown.