summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py2
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])),
]