File tree Expand file tree Collapse file tree 2 files changed +15
-1
lines changed Expand file tree Collapse file tree 2 files changed +15
-1
lines changed Original file line number Diff line number Diff line change @@ -139,6 +139,18 @@ numpydoc_validation_exclude : set
139
139
validation.
140
140
Only has an effect when docstring validation is activated, i.e.
141
141
``numpydoc_validation_checks `` is not an empty set.
142
+ numpydoc_validation_exclude_files : set
143
+ A container of strings using :py:mod: `re ` syntax specifying path patterns to
144
+ ignore for docstring validation.
145
+ For example, to skip docstring validation for all objects in
146
+ ``tests\ ``::
147
+
148
+ numpydoc_validation_exclude_files = {"$.*tests/.*"}
149
+
150
+ The default is an empty set meaning no paths are excluded from docstring
151
+ validation.
152
+ Only has an effect when docstring validation is activated, i.e.
153
+ ``numpydoc_validation_checks `` is not an empty set.
142
154
numpydoc_validation_overrides : dict
143
155
A dictionary mapping :ref: `validation checks <validation_checks >` to a
144
156
container of strings using :py:mod: `re ` syntax specifying patterns to
Original file line number Diff line number Diff line change @@ -37,7 +37,9 @@ the pre-commit hook as follows:
37
37
maps to ``numpydoc_validation_exclude `` from the
38
38
:ref: `Sphinx build configuration <validation_during_sphinx_build >`.
39
39
* ``exclude_files ``: Exclude file paths matching the regular expressions
40
- ``^tests/.* `` or ``^module/gui.* ``.
40
+ ``^tests/.* `` or ``^module/gui.* ``. This maps to
41
+ ``numpydoc_validation_exclude_files `` from the
42
+ :ref: `Sphinx build configuration <validation_during_sphinx_build >`.
41
43
* ``override_SS05 ``: Allow docstrings to start with "Process ", "Assess ",
42
44
or "Access ". To override different checks, add a field for each code in
43
45
the form of ``override_<code> `` with a collection of regular expression(s)
You can’t perform that action at this time.
0 commit comments