From a924e14becb37288a3dcbf8ff613ce43c24f1da6 Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Tue, 22 Aug 2023 20:38:52 +0100 Subject: Add pydantic BaseModel to target to ignore --- docs/conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 683f9e51..b06300a3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -155,14 +155,15 @@ def setup(app: Sphinx) -> None: app.add_role("breaking", releases.issues_role) -ignored_modules = [ +ignored_targets = [ "async_rediscache", + "pydantic.main.BaseModel" ] # 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. +# This is a workaround for modules/classes that do not have docs that can be linked out to. nitpick_ignore_regex = [ - ("py:.*", "|".join([f".*{entry}.*" for entry in ignored_modules])), + ("py:.*", "|".join([f".*{entry}.*" for entry in ignored_targets])), ] # -- Extension configuration ------------------------------------------------- -- cgit v1.2.3