Skip to content

Commit a924e14

Browse files
committed
Add pydantic BaseModel to target to ignore
1 parent a2daec6 commit a924e14

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,14 +155,15 @@ def setup(app: Sphinx) -> None:
155155
app.add_role("breaking", releases.issues_role)
156156

157157

158-
ignored_modules = [
158+
ignored_targets = [
159159
"async_rediscache",
160+
"pydantic.main.BaseModel"
160161
]
161162

162163
# nitpick raises warnings as errors. This regex tells nitpick to ignore any warnings that match this regex.
163-
# This is a workaround for modules that do not have docs that can be linked out to.
164+
# This is a workaround for modules/classes that do not have docs that can be linked out to.
164165
nitpick_ignore_regex = [
165-
("py:.*", "|".join([f".*{entry}.*" for entry in ignored_modules])),
166+
("py:.*", "|".join([f".*{entry}.*" for entry in ignored_targets])),
166167
]
167168

168169
# -- Extension configuration -------------------------------------------------

0 commit comments

Comments
 (0)