diff options
| author |  Chris Lovering <[email protected]> | 2022-03-24 07:49:02 +0000 |
|---|---|---|
| committer | Chris Lovering <[email protected]> | 2022-03-24 08:25:28 +0000 |
| commit | 08d4b717f1d5b6c66137a3b0d333799f024b86df (patch) | |
| tree | 6f91d0e96b79521b1fb7fb9953f238ffabac2b8d /docs/conf.py | |
| parent | Provide a bot.all_extensions instance attribute (diff) | |
Comment on what nitpick_ignore_regex does in conf.py
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8b55b58a..8cbf5352 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,6 +111,8 @@ ignored_modules = [ "async_rediscache", ] +# nitpick raises warnings as errors. This regex tells nitpick to ignore any warnings that match this regex. +# This is a workaround for modules that do not have docs that can be linked out to. nitpick_ignore_regex = [ ("py:.*", "|".join([f".*{entry}.*" for entry in ignored_modules])), ] |