From 08d4b717f1d5b6c66137a3b0d333799f024b86df Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Thu, 24 Mar 2022 07:49:02 +0000 Subject: Comment on what nitpick_ignore_regex does in conf.py --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/conf.py') 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])), ] -- cgit v1.2.3