From 104d0a3f6914f7ba9031fe396bd99ad29990104d Mon Sep 17 00:00:00 2001 From: ruro Date: Sat, 24 Apr 2021 02:13:55 +0300 Subject: [PATCH] describe nitpick_ignore_regex in docs --- doc/usage/configuration.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 7b7a0a1d4..95a4b6267 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -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