summaryrefslogtreecommitdiff
path: root/doc/usage/extensions/autodoc.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/usage/extensions/autodoc.rst')
-rw-r--r--doc/usage/extensions/autodoc.rst24
1 files changed, 21 insertions, 3 deletions
diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst
index 064463691..36d497543 100644
--- a/doc/usage/extensions/autodoc.rst
+++ b/doc/usage/extensions/autodoc.rst
@@ -45,6 +45,10 @@ docstrings to correct reStructuredText before :mod:`autodoc` processes them.
.. _NumPy:
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
+
+Directives
+----------
+
:mod:`autodoc` provides several directives that are versions of the usual
:rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, they
import the corresponding module and extract the docstring of the given objects,
@@ -306,6 +310,9 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
well-behaved decorating functions.
+Configuration
+-------------
+
There are also new config values that you can set:
.. confval:: autoclass_content
@@ -376,9 +383,10 @@ There are also new config values that you can set:
Setting ``None`` is equivalent to giving the option name in the list format
(i.e. it means "yes/true/on").
- The supported options are ``'members'``, ``'undoc-members'``,
- ``'private-members'``, ``'special-members'``, ``'inherited-members'``,
- ``'show-inheritance'``, ``'ignore-module-all'`` and ``'exclude-members'``.
+ The supported options are ``'members'``, ``'member-order'``,
+ ``'undoc-members'``, ``'private-members'``, ``'special-members'``,
+ ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and
+ ``'exclude-members'``.
.. versionadded:: 1.8
@@ -432,6 +440,16 @@ There are also new config values that you can set:
.. versionadded:: 1.7
+.. confval:: suppress_warnings
+ :noindex:
+
+ :mod:`autodoc` supports to suppress warning messages via
+ :confval:`suppress_warnings`. It allows following warnings types in
+ addition:
+
+ * autodoc
+ * autodoc.import_object
+
Docstring preprocessing
-----------------------