IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

describe nitpick_ignore_regex in docs

Browse Source
This commit is contained in:
ruro 2021-04-24 02:13:55 +03:00
parent 00bc3465b3
commit 104d0a3f69
No known key found for this signature in database
GPG Key ID: 58187C6CC59F5BB0
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/usage/configuration.rst
View File

@ -419,6 +419,20 @@ General configuration
.. versionadded:: 1.1
.. confval:: nitpick_ignore_regex
An extended version of :confval:`nitpick_ignore`, which instead interprets
the ``type`` and ``target`` strings as regular expressions. Note, that the
regular expression must match the whole string (as if the ``^`` and ``$``
markers were inserted).
For example, ``(r'py:.*', r'foo.*bar\.B.*')`` will ignore nitpicky warnings
for all python entities that start with ``'foo'`` and have ``'bar.B'`` in
them, such as ``('py:const', 'foo_package.bar.BAZ_VALUE')`` or
``('py:class', 'food.bar.Barman')``.
.. versionadded:: 4.1
.. confval:: numfig
If true, figures, tables and code-blocks are automatically numbered if they