sphinx-doc / sphinx-doc/sphinx-argparse
Relative markdown links generate "no command xref target" warnings in v0.6.0
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
Markdown links to files produce compilation warnings during sphinx-build, even if the links themselves are valid and successfully resolved by Sphinx. Example:
WARNING: Error, no command xref target from releases/changelog:./DEPRECATED
This is new as of v0.6.0.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the warning with sphinx-build using a Markdown link to a relative file, focusing on the behavior introduced in v0.6.0. Trace how the link is resolved and why a command xref warning is emitted. Done means valid relative links still resolve and sphinx-build completes without the warning, with coverage for the reported example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100