New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Add a custom extension to report unresolved cross-references #110177
Open
AA-Turner
wants to merge
6
commits into
python:main
Choose a base branch
from
AA-Turner:docs/refwarn/ext
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
sobolevn
reviewed
Oct 1, 2023
Sounds potentially useful, but it's not generating them at the moment due to an error:
Please could you post some example files? |
hugovk
reviewed
Oct 1, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AA-Turner
commented
Oct 3, 2023
refwarn.csv:
refwarn_count.csv:
A |
Looks useful. Does it make sense to write out the CSV files (empty except headers) when not run in nitpicky mode? Maybe add some type hints? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
awaiting review
docs
Documentation in the Doc dir
skip issue
skip news
type-feature
A feature request or enhancement
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.
This adds a custom Sphinx extension to report missing and unresolved cross-references, saving two files to the Sphinx build directory (
refwarn.csv
andrefwarn_count.csv
).The first file reports every instance of missing references as reported by Sphinx, with the domain (e.g.
py
), role name (e.g.func
), reference target (e.g.sum
), and source file name, in a CSV format.The second file aggregates the count of missing references in domain-role-target triples (ignoring the source file), giving a potential prioritisation order for missing references across the documentation.
This PR is presented as a sketch -- I think it is useful (I use it), but I can see arguments against merging it -- especially as I hope that it will someday be deleted!
A
📚 Documentation preview 📚: https://cpython-previews--110177.org.readthedocs.build/