Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/417.trivial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix the ``tox -e docs`` build, which failed under ``sphinx-build -W`` because nitpicky mode reported unresolved references to the private names ``_tracing.TagTracerSub``, ``DistFacade`` and ``_Plugin``.
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,19 @@
autodoc_member_order = "bysource"

nitpicky = True
# Some annotations in `pluggy._manager` reference names that only exist under
# `typing.TYPE_CHECKING` (`DistFacade`, `importlib.metadata`), so autodoc cannot
# evaluate them and falls back to the annotation as written in the source.
# That means private names show up both fully qualified and as written.
nitpick_ignore = {
# Don't want to expose this yet (see #428).
("py:class", "pluggy._tracing.TagTracerSub"),
("py:class", "_tracing.TagTracerSub"),
# Compat hack, don't want to expose it.
("py:class", "pluggy._compat.DistFacade"),
("py:class", "DistFacade"),
# Private alias for `object`.
("py:class", "_Plugin"),
# `types.ModuleType` turns into `module` but then fails to resolve...
("py:class", "module"),
# Just a TypeVar.
Expand Down