Use canonical RFC Editor URLs independently of Docutils

AUTHORS.rst

@@ -81,6 +81,7 @@ Contributors
 * Justus Magin -- napoleon improvements
 * Kazuya Take -- ``sphinx.testing.path`` bug fix
 * Kevin Dunn -- MathJax extension
+* Kilian Paul -- Docutils compatibility, intl tests, and viewcode fixes
 * KINEBUCHI Tomohiko -- typing Sphinx as well as docutils
 * Kurt McKee -- documentation updates
 * Lars Hupfeldt Nielsen - OpenSSL FIPS mode md5 bug fix

CHANGES.rst

@@ -4,6 +4,11 @@ Release 9.1.1 (in development)
 Bugs fixed
 ----------
 
+* #14659: Use the canonical ``https://www.rfc-editor.org/info/`` base URL for
+  the :rst:role:`rfc` role and make generated RFC URLs independent of
+  Docutils' URL template.
+  Patch by Kilian Paul
+
 * #14465: LaTeX: PDF build crash since LaTeX June 2026 release if tables are
   styled with ``'colorrows'`` (which is the default).
   Patch by Jean-François B.

sphinx/environment/__init__.py

@@ -63,7 +63,7 @@
     'cloak_email_addresses': True,
     'pep_base_url': 'https://peps.python.org/',
     'pep_references': None,
-    'rfc_base_url': 'https://datatracker.ietf.org/doc/html/',
+    'rfc_base_url': 'https://www.rfc-editor.org/info/',
     'rfc_references': None,
     'input_encoding': 'utf-8-sig',
     'doctitle_xform': False,
@@ -76,7 +76,7 @@
 
 # This is increased every time an environment attribute is added
 # or changed to properly invalidate pickle files.
-ENV_VERSION = 66
+ENV_VERSION = 67
 
 # config status
 CONFIG_UNSET = -1

sphinx/roles.py

@@ -360,11 +360,11 @@ def run(self) -> tuple[list[Node], list[system_message]]:
 
     def build_uri(self) -> str:
         base_url = self.inliner.document.settings.rfc_base_url
-        ret = self.target.partition('#')
-        if ret[1]:
-            return base_url + self.inliner.rfc_url % int(ret[0]) + '#' + ret[2]
-        else:
-            return base_url + self.inliner.rfc_url % int(ret[0])
+        number, separator, anchor = self.target.partition('#')
+        uri = f'{base_url}rfc{int(number)}/'
+        if separator:
+            uri += f'#{anchor}'
+        return uri
 
 
 def _format_rfc_target(target: str, /) -> str:

tests/test_builders/test_build_html_5_output.py

@@ -147,13 +147,13 @@ def checker(nodes: Iterable[Element]) -> Literal[True]:
         ),
         (
             'markup.html',
-            ".//a[@href='https://datatracker.ietf.org/doc/html/rfc1.html']"
+            ".//a[@href='https://www.rfc-editor.org/info/rfc1/']"
             "[@class='rfc reference external']/strong",
             'RFC 1',
         ),
         (
             'markup.html',
-            ".//a[@href='https://datatracker.ietf.org/doc/html/rfc1.html']"
+            ".//a[@href='https://www.rfc-editor.org/info/rfc1/']"
             "[@class='rfc reference external']/strong",
             'Request for Comments #1',
         ),

tests/test_markup/test_markup.py

@@ -212,12 +212,12 @@ def rst_to_latex(rst: str, *, app: SphinxTestApp) -> str:
             ':rfc:`2324`',
             (
                 '<p><span class="target" id="index-0"></span><a class="rfc reference external" '
-                'href="https://datatracker.ietf.org/doc/html/rfc2324.html"><strong>RFC 2324</strong></a></p>'
+                'href="https://www.rfc-editor.org/info/rfc2324/"><strong>RFC 2324</strong></a></p>'
             ),
             (
                 '\\sphinxAtStartPar\n'
                 '\\index{RFC@\\spxentry{RFC}!RFC 2324@\\spxentry{RFC 2324}}'
-                '\\sphinxhref{https://datatracker.ietf.org/doc/html/rfc2324.html}'
+                '\\sphinxhref{https://www.rfc-editor.org/info/rfc2324/}'
                 '{\\sphinxstylestrong{RFC 2324}}'
             ),
         ),
@@ -226,13 +226,13 @@ def rst_to_latex(rst: str, *, app: SphinxTestApp) -> str:
             ':rfc:`2324#section-1`',
             (
                 '<p><span class="target" id="index-0"></span><a class="rfc reference external" '
-                'href="https://datatracker.ietf.org/doc/html/rfc2324.html#section-1">'
+                'href="https://www.rfc-editor.org/info/rfc2324/#section-1">'
                 '<strong>RFC 2324 Section 1</strong></a></p>'
             ),
             (
                 '\\sphinxAtStartPar\n'
                 '\\index{RFC@\\spxentry{RFC}!RFC 2324 Section 1@\\spxentry{RFC 2324 Section 1}}'
-                '\\sphinxhref{https://datatracker.ietf.org/doc/html/rfc2324.html\\#section-1}'
+                '\\sphinxhref{https://www.rfc-editor.org/info/rfc2324/\\#section-1}'
                 '{\\sphinxstylestrong{RFC 2324 Section 1}}'
             ),
         ),

tests/test_roles.py

@@ -2,14 +2,19 @@
 
 from __future__ import annotations
 
+from types import SimpleNamespace
+from typing import TYPE_CHECKING, cast
 from unittest.mock import Mock
 
 import pytest
 from docutils import nodes
 
-from sphinx.roles import EmphasizedLiteral, _format_rfc_target
+from sphinx.roles import RFC, EmphasizedLiteral, _format_rfc_target
 from sphinx.testing.util import assert_node
 
+if TYPE_CHECKING:
+    from docutils.parsers.rst.states import Inliner
+
 
 def test_samp() -> None:
     emph_literal_role = EmphasizedLiteral()
@@ -137,3 +142,22 @@ def test_samp() -> None:
 )
 def test_format_rfc_target(target: str, expected_output: str) -> None:
     assert _format_rfc_target(target) == expected_output
+
+
+@pytest.mark.parametrize(
+    ('target', 'expected_uri'),
+    [
+        ('2324', 'https://example.com/rfc/rfc2324/'),
+        ('2324#section-1', 'https://example.com/rfc/rfc2324/#section-1'),
+        ('2324#', 'https://example.com/rfc/rfc2324/#'),
+    ],
+)
+def test_rfc_build_uri(target: str, expected_uri: str) -> None:
+    role = RFC()
+    settings = SimpleNamespace(rfc_base_url='https://example.com/rfc/')
+    role.inliner = cast(
+        'Inliner', SimpleNamespace(document=SimpleNamespace(settings=settings))
+    )
+    role.target = target
+
+    assert role.build_uri() == expected_uri