Skip to content

Commit 22c56f3

Browse files
committed
DOC: Add numpydoc_validate to conf docs.
1 parent d105037 commit 22c56f3

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/install.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ numpydoc_xref_ignore : set or ``"all"``
9696
desired cross reference mappings in ``numpydoc_xref_aliases`` and setting
9797
``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing
9898
terms to ignore in a set.
99+
numpydoc_validate : bool
100+
Whether or not to run docstring validation during the sphinx-build process.
101+
Default is ``False``.
99102
numpydoc_edit_link : bool
100103
.. deprecated:: 0.7.0
101104

0 commit comments

Comments
 (0)