Repository navigation
Rename the ref role to obj - #25
Merged
Merged
Conversation
With cs as the default domain, Sphinx resolved a plain :ref: as :cs:ref:, so section labels were not found. The obj name follows :py:obj:, which also matches any object type.
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
1 participant
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.
Problem. Sphinx resolves an unprefixed role in the default domain before
std. With.. default-domain:: csorprimary_domain = 'cs', a plain:ref:became:cs:ref:, and section labels failed with "cs:ref reference target not found".Fix. Rename the role to
:cs:obj:, following:py:obj:, which also matches any object type.anywould shadow the global:any:role in the same way.Testing. A new render test builds with
csas the default domain and checks that:ref:reaches a section label. It failed before the rename. The test-basic project now uses both:ref:and:obj:in its nitpicky build.