parent
9e9c28e15b
commit
03f601ed41
@ -0,0 +1,34 @@
|
||||
Autodoc-Style Directives
|
||||
------------------------
|
||||
|
||||
You can opt to write API documentation yourself using autodoc style directives.
|
||||
These directives work similarly to autodoc,
|
||||
but docstring are retrieved through static analysis instead of through imports.
|
||||
|
||||
To use these directives you will need to enable the autodoc extension
|
||||
in your Sphinx project's ``conf.py``:
|
||||
|
||||
.. code:: python
|
||||
|
||||
extensions = ['sphinx.ext.autodoc', 'autoapi.extension']
|
||||
|
||||
|
||||
For Python, all directives have an autodoc equivalent
|
||||
and accept the same options.
|
||||
The following directives are available:
|
||||
|
||||
.. rst:directive:: autoapimodule
|
||||
autoapiclass
|
||||
autoapiexception
|
||||
|
||||
Equivalent to :rst:dir:`automodule`, :rst:dir:`autoclass`,
|
||||
and :rst:dir:`autoexception` respectively.
|
||||
:confval:`autodoc_inherit_docstrings` does not currently work.
|
||||
|
||||
.. rst:directive:: autoapifunction
|
||||
autoapidata
|
||||
autoapimethod
|
||||
autoapiattribute
|
||||
|
||||
Equivalent to :rst:dir:`autofunction`, :rst:dir:`autodata`,
|
||||
:rst:dir:`automethod`, and :rst:dir:`autoattribute` respectively.
|
Loading…
Reference in New Issue