Use canonical rfc-editor.org URL for the :rfc: role - #14662
Draft
sidsri14 wants to merge 3 commits into
Draft
Conversation
Change the default rfc_base_url to https://www.rfc-editor.org/rfc/ so that RFC references link to the canonical location where RFCs are officially published, instead of datatracker.ietf.org.
|
fwiw the canonical RFC location is Routes like https://www.rfc-editor.org/rfc/rfc2324.html have an HTTP header canonical url of |
Point rfc_base_url at https://www.rfc-editor.org/info/ and build rfcN/ links (no .html suffix, trailing slash) instead of relying on docutils' rfc%d.html format, matching the canonical rfc-editor.org location noted in review. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Author
|
Done — thanks for the pointer, @holloway. I've switched to the canonical
Tests updated and passing. |
This was referenced Sep 2, 2026
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
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.
Purpose
Change the default
rfc_base_urlso the:rfc:role links to thecanonical RFC Editor location
(
https://www.rfc-editor.org/rfc/rfcNNNN.html) instead ofhttps://datatracker.ietf.org/doc/html/rfcNNNN.html.RFCs are officially published at rfc-editor.org, and datatracker has started
emitting a canonical link to rfc-editor.org for its RFC HTML pages
(see ietf-tools/datatracker#11481), confirming the rfc-editor.org URLs as
canonical.
rfc_base_urldefault insphinx/environment/__init__.pytests/test_markup/test_markup.pyand
tests/test_builders/test_build_html_5_output.pyCHANGES.rstentry and anAUTHORS.rstentryNote: this only changes the default; users can still override
rfc_base_urlexplicitly.References
Closes #14659
AI disclosure
This change was prepared with the assistance of Claude Code (Anthropic).
All changes were reviewed and verified locally before submission.