[FEATURE] Introduce option directive #636
Merged
Conversation
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
linawolf
force-pushed
the
feature/standard-domain
branch
2 times, most recently
from
1a04504 to
b8d5ef5
Compare
jaapio
requested changes
Oct 30, 2023
There was a problem hiding this comment.
It feels like the term intersphinxDomain is invalid or should not be part of our core library. I'm still thinking if and how intersphinx should be part of our core. However domains are a more common thing in rst, at least it sounds less sphinx specific. Which makes sense to me to rename the current getIntersphinxDomain to getDomain
I think the :option: domain should have it's own ReferenceResolver, it's another type of reference, so let's model it like that. This ReferenceResolver should be part of the Rst package as it is not a shared concept between RST and Markdown for example. Probably this is also the reason why you have put the node inside the RST extension.
packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php
Outdated
Show resolved
Hide resolved
Options can be linked with the special text-role :option: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option
This prevent the intersphinx part from being reduced by the anchor reducer
linawolf
force-pushed
the
feature/standard-domain
branch
from
50ae817 to
95e84ad
Compare
jaapio
approved these changes
Nov 2, 2023
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.
Options can be linked with the special text-role :option:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option
depends on #627