Skip to content

Fix documentation build with Pluggy 1.7 - #15191

Closed
Lothnic wants to merge 1 commit into
pytest-dev:mainfrom
Lothnic:codex/docs-pluggy-distfacade
Closed

Lothnic wants to merge 1 commit into
pytest-dev:mainfrom
Lothnic:codex/docs-pluggy-distfacade

Conversation

@Lothnic

@Lothnic Lothnic commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Fixes #15190.

With Pluggy 1.7.0, tox -e docs fails because the inherited PluginManager.list_plugin_distinfo docstring links to the undocumented private class pluggy._compat.DistFacade. Sphinx cannot resolve that target, and the documentation build treats warnings as errors.

Add that exact class reference to the existing nitpick_ignore list under undocumented third-party types. Other missing references still fail the build. A contributor changelog entry records the fix.

Validation:

  • Reproduced the failure on unmodified main, including a clean Sphinx build.
  • tox -e docs passes with Python 3.14.6, Pluggy 1.7.0 and Sphinx 9.1.0.
  • A clean strict build (sphinx-build -E -a -j 4 -W --keep-going -b html) also passes.
  • Ruff checks, Ruff formatting and git diff --check pass.
  • Before the fix, tox -e py314 completed with 4,695 passed, 48 skipped, 17 xfailed and 4 xpassed. The change only affects documentation configuration.

The full pre-commit run could not complete because DNS resolution failed while fetching a hook dependency from GitHub.

AI assistance was used for investigation, implementation and preparation of this description.

Copilot AI balanced review requested due to automatic review settings October 16, 2026 04:43
@pyba-chronographer pyba-chronographer Bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Oct 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

Ignore the undocumented DistFacade class reference inherited from Pluggy in the strict documentation build.

Fixes pytest-dev#15190.
@Lothnic
Lothnic force-pushed the codex/docs-pluggy-distfacade branch from eb06190 to 0d6b61d Compare October 16, 2026 04:44
@Lothnic Lothnic closed this Oct 16, 2026
@Lothnic
Lothnic deleted the codex/docs-pluggy-distfacade branch October 16, 2026 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided (automation) changelog entry is part of PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs build fails with Pluggy 1.7.0 on an unresolved private DistFacade reference

2 participants