Doc: add anchormap directive for anchor redirects#151113
Open
StanFromIreland wants to merge 1 commit into
Open
Doc: add anchormap directive for anchor redirects#151113StanFromIreland wants to merge 1 commit into
anchormap directive for anchor redirects#151113StanFromIreland wants to merge 1 commit into
Conversation
Documentation build overview
|
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.
See python/docs-community#134 (and python/docs-community#58) for prior discussion and motivation. The
.. anchormap::lets us declareold-anchor: :ref:`new-target`entries, which theanchor_redirects.pyextension resolves at build time and embeds as JSON in the page. A small Javascript script then redirects any achor to its new location.To see it in action, go to: https://cpython-previews--151113.org.readthedocs.build/en/151113/using/configure.html#cmdoption-with-system-libmpdec
For that example, the extension added to
using/configure.html:In this PR I only removed one entry from
removed-ids.txtto serve as an example, the rest can be done in follow-ups.