Fixes for "rST primer" hyperlinks section.#14237
Open
gmilde wants to merge 1 commit intosphinx-doc:masterfrom
Open
Fixes for "rST primer" hyperlinks section.#14237gmilde wants to merge 1 commit intosphinx-doc:masterfrom
gmilde wants to merge 1 commit intosphinx-doc:masterfrom
Conversation
Add a link to the "standalone hyperlinks" specification. Use a dedicated example URI instead of `https://domain.invalid/`. Separate targets may also sensibly be placed at the end of the document (especially, when they are referenced more than once). Shorten the "tip" to use an anonymous URL when embedding the target: Since Docutils 0.22, named hyperlinks with embedded URI generate "implicit" targets. This allows re-use of the link name with a different URI (a "warning" is logged). Remove duplicate paragraph documenting named hyperlinks with separate targets. Fixes sphinx-doc#13613.
Contributor
Author
|
The failing check is about type hints somewhere in the code, not about this documentation patch! |
Contributor
Reported as #14238; hopefully with a fix ready in a few moments, too. |
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.
Add a link to the "standalone hyperlinks" specification.
Use a dedicated example URI instead of
https://domain.invalid/.Separate targets may also sensibly be placed at the end of the document (especially, when they are referenced more than once).
Shorten the "tip" to use an anonymous URL when embedding the target: Since Docutils 0.22, named hyperlinks with embedded URI generate "implicit" targets. This allows re-use of the link name with a different URI (a "warning" is logged).
Remove duplicate paragraph documenting named hyperlinks with separate targets.
References