Skip to content

Commit 0fe6cf1

Browse files
committed
docs/conf.py(chore): suppress forward reference warnings
why: Types in TYPE_CHECKING blocks for circular import avoidance generate cosmetic warnings that clutter build output what: - Add suppress_warnings list with forward_reference filter
1 parent f2a8333 commit 0fe6cf1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@
125125
always_document_param_types = False
126126
# Disable return type injection in docstrings (types shown in signature only)
127127
typehints_document_rtype = False
128+
# Suppress cosmetic warnings for forward references in TYPE_CHECKING blocks
129+
suppress_warnings = [
130+
"sphinx_autodoc_typehints.forward_reference",
131+
]
128132

129133
# sphinx.ext.napoleon
130134
napoleon_google_docstring = True

0 commit comments

Comments
 (0)