Skip to content

Commit 2aa8743

Browse files
committed
doc: enable Sphinx nitpicky mode
See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky This ensures we have no more broken references.
1 parent ee91d09 commit 2aa8743

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

doc/en/conf.py

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,50 @@
169169
}
170170

171171

172+
nitpicky = True
173+
nitpick_ignore = [
174+
# TODO (fix in pluggy?)
175+
("py:class", "HookCaller"),
176+
("py:class", "HookspecMarker"),
177+
("py:exc", "PluginValidationError"),
178+
# Might want to expose/TODO (https://github.com/pytest-dev/pytest/issues/7469)
179+
("py:class", "ExceptionRepr"),
180+
("py:class", "Exit"),
181+
("py:class", "SubRequest"),
182+
("py:class", "SubRequest"),
183+
("py:class", "TerminalReporter"),
184+
("py:class", "_pytest._code.code.TerminalRepr"),
185+
("py:class", "_pytest.fixtures.FixtureFunctionMarker"),
186+
("py:class", "_pytest.logging.LogCaptureHandler"),
187+
("py:class", "_pytest.mark.structures.ParameterSet"),
188+
# Intentionally undocumented/private
189+
("py:class", "_pytest._code.code.Traceback"),
190+
("py:class", "_pytest._py.path.LocalPath"),
191+
("py:class", "_pytest.capture.CaptureResult"),
192+
("py:class", "_pytest.compat.NotSetType"),
193+
("py:class", "_pytest.python.PyCollector"),
194+
("py:class", "_pytest.python.PyobjMixin"),
195+
("py:class", "_pytest.python_api.RaisesContext"),
196+
("py:class", "_pytest.recwarn.WarningsChecker"),
197+
("py:class", "_pytest.reports.BaseReport"),
198+
# Undocumented third parties
199+
("py:class", "_tracing.TagTracerSub"),
200+
("py:class", "warnings.WarningMessage"),
201+
# Undocumented type aliases
202+
("py:class", "LEGACY_PATH"),
203+
("py:class", "_PluggyPlugin"),
204+
# TypeVars
205+
("py:class", "_pytest._code.code.E"),
206+
("py:class", "_pytest.fixtures.FixtureFunction"),
207+
("py:class", "_pytest.nodes._NodeType"),
208+
("py:class", "_pytest.python_api.E"),
209+
("py:class", "_pytest.recwarn.T"),
210+
("py:class", "_pytest.runner.TResult"),
211+
("py:obj", "_pytest.fixtures.FixtureValue"),
212+
("py:obj", "_pytest.stash.T"),
213+
]
214+
215+
172216
# -- Options for HTML output ---------------------------------------------------
173217

174218
sys.path.append(os.path.abspath("_themes"))

0 commit comments

Comments
 (0)