Fix docs build broken by sphinx-argparse commands domain#2551
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Sphinx documentation configuration to silence a specific class of MyST-Parser warnings during docs builds, reducing noise from known/expected warnings in the Olive docs pipeline.
Changes:
- Extends
suppress_warningsindocs/source/conf.pyto includemyst.domainsalongside the existingmyst.xref_missingsuppression.
…ommands domain Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
justinchuby
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
sphinx-argparse 0.6.0 registers a
commandsdomain (ArgParseDomain) that does not implement the standard SphinxDomain.resolve_any_xrefAPI. MyST falls back to calling the domain'sresolve_xreffor every markdown cross-reference, and that method logsError, no command xref target from ...for each target it doesn't own, including links that already resolve via doc/std resolution. Under-W, this flood of warnings fails the docs build.This adds a
resolve_any_xrefimplementation toArgParseDomainindocs/source/conf.py, supplying the API the extension omits so MyST resolves real command targets and skips the noisy fallback. This also removes themyst.domainslegacy-domain warning, so the earliersuppress_warningsentry for it is dropped. No version pin is added todocs/requirements.txt.The rendered HTML is byte-identical to before; only the spurious warnings are gone. The
sphinx-build -Wbuild passes.Checklist before requesting a review
lintrunner -a(Optional) Issue link