sphinxdocs: make xrefs to tag class attributes using attr role work#2895
Merged
rickeylev merged 1 commit intobazel-contrib:mainfrom May 17, 2025
Merged
Conversation
dougthor42
approved these changes
May 17, 2025
Collaborator
dougthor42
left a comment
There was a problem hiding this comment.
I'm kinda surprised that rules_python seems to have such complex sphinx stuff.
My naive thought is that basic ReST and proper sphinx autolinking syntax should be sufficient.
Is a lot of it just so that docs can be built using Bazel? Or because we want to write docs and docstrings as (MyST|markdown) instead of ReST?
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
2 participants
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.
The role assigned to attributes within the tag class directive were being given the
role
arg, when they should beattr. This caused xrefs using the attr role tobe unable to find them.
To fix, set them to have the correct role, like the repo rule and regular rule
directives do. Also add a test.