IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update RFC base url

Browse Source 
The tools.ietf.org subdomain is being wound down and services are moving to
datatracker.ietf.org. Links to RFC documents using the old subdomain are being
redirected to datatracker; this updates the configured `rfc_base_url` to
point to the current subdomain.

Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
This commit is contained in:
Matt Ficke 2021-11-16 10:52:02 -05:00
parent cee86909b9
commit 2ed4bed33a
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/usage/configuration.rst
View File

@ -1005,7 +1005,7 @@ that use Sphinx's HTMLWriter class.
to indicate the location of document using `The Canonical Link Relation`_. to indicate the location of document using `The Canonical Link Relation`_.
Default: ``''``. Default: ``''``.
.. _The Canonical Link Relation: https://tools.ietf.org/html/rfc6596 .. _The Canonical Link Relation: https://datatracker.ietf.org/doc/html/rfc6596
.. versionadded:: 1.8 .. versionadded:: 1.8
@ -2679,7 +2679,7 @@ Options for the linkcheck builder
doubling the wait time between attempts until it succeeds or exceeds the doubling the wait time between attempts until it succeeds or exceeds the
``linkcheck_rate_limit_timeout``. By default, the timeout is 5 minutes. ``linkcheck_rate_limit_timeout``. By default, the timeout is 5 minutes.
.. _Retry-After: https://tools.ietf.org/html/rfc7231#section-7.1.3 .. _Retry-After: https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.3
.. versionadded:: 3.4 .. versionadded:: 3.4

2
sphinx/environment/__init__.py
View File

@ -51,7 +51,7 @@ default_settings: Dict[str, Any] = {
'cloak_email_addresses': True, 'cloak_email_addresses': True,
'pep_base_url': 'https://www.python.org/dev/peps/', 'pep_base_url': 'https://www.python.org/dev/peps/',
'pep_references': None, 'pep_references': None,
'rfc_base_url': 'https://tools.ietf.org/html/', 'rfc_base_url': 'https://datatracker.ietf.org/doc/html/',
'rfc_references': None, 'rfc_references': None,
'input_encoding': 'utf-8-sig', 'input_encoding': 'utf-8-sig',
'doctitle_xform': False, 'doctitle_xform': False,

4
tests/test_build_html.py
View File

@ -225,9 +225,9 @@ def test_html4_output(app, status, warning):
(".//a[@href='https://www.python.org/dev/peps/pep-0008']" (".//a[@href='https://www.python.org/dev/peps/pep-0008']"
"[@class='pep reference external']/strong", "[@class='pep reference external']/strong",
'Python Enhancement Proposal #8'), 'Python Enhancement Proposal #8'),
(".//a[@href='https://tools.ietf.org/html/rfc1.html']" (".//a[@href='https://datatracker.ietf.org/doc/html/rfc1.html']"
"[@class='rfc reference external']/strong", 'RFC 1'), "[@class='rfc reference external']/strong", 'RFC 1'),
(".//a[@href='https://tools.ietf.org/html/rfc1.html']" (".//a[@href='https://datatracker.ietf.org/doc/html/rfc1.html']"
"[@class='rfc reference external']/strong", 'Request for Comments #1'), "[@class='rfc reference external']/strong", 'Request for Comments #1'),
(".//a[@href='objects.html#envvar-HOME']" (".//a[@href='objects.html#envvar-HOME']"
"[@class='reference internal']/code/span[@class='pre']", 'HOME'), "[@class='reference internal']/code/span[@class='pre']", 'HOME'),

10
tests/test_markup.py
View File

@ -36,7 +36,7 @@ def settings(app):
settings.env = app.builder.env settings.env = app.builder.env
settings.env.temp_data['docname'] = 'dummy' settings.env.temp_data['docname'] = 'dummy'
settings.contentsname = 'dummy' settings.contentsname = 'dummy'
settings.rfc_base_url = 'http://tools.ietf.org/html/' settings.rfc_base_url = 'http://datatracker.ietf.org/doc/html/'
domain_context = sphinx_domains(settings.env) domain_context = sphinx_domains(settings.env)
domain_context.enable() domain_context.enable()
yield settings yield settings
@ -181,10 +181,10 @@ def get_verifier(verify, verify_re):
'verify', 'verify',
':rfc:`2324`', ':rfc:`2324`',
('<p><span class="target" id="index-0"></span><a class="rfc reference external" ' ('<p><span class="target" id="index-0"></span><a class="rfc reference external" '
'href="http://tools.ietf.org/html/rfc2324.html"><strong>RFC 2324</strong></a></p>'), 'href="http://datatracker.ietf.org/doc/html/rfc2324.html"><strong>RFC 2324</strong></a></p>'),
('\\sphinxAtStartPar\n' ('\\sphinxAtStartPar\n'
'\\index{RFC@\\spxentry{RFC}!RFC 2324@\\spxentry{RFC 2324}}' '\\index{RFC@\\spxentry{RFC}!RFC 2324@\\spxentry{RFC 2324}}'
'\\sphinxhref{http://tools.ietf.org/html/rfc2324.html}' '\\sphinxhref{http://datatracker.ietf.org/doc/html/rfc2324.html}'
'{\\sphinxstylestrong{RFC 2324}}') '{\\sphinxstylestrong{RFC 2324}}')
), ),
( (
@ -192,11 +192,11 @@ def get_verifier(verify, verify_re):
'verify', 'verify',
':rfc:`2324#id1`', ':rfc:`2324#id1`',
('<p><span class="target" id="index-0"></span><a class="rfc reference external" ' ('<p><span class="target" id="index-0"></span><a class="rfc reference external" '
'href="http://tools.ietf.org/html/rfc2324.html#id1">' 'href="http://datatracker.ietf.org/doc/html/rfc2324.html#id1">'
'<strong>RFC 2324#id1</strong></a></p>'), '<strong>RFC 2324#id1</strong></a></p>'),
('\\sphinxAtStartPar\n' ('\\sphinxAtStartPar\n'
'\\index{RFC@\\spxentry{RFC}!RFC 2324\\#id1@\\spxentry{RFC 2324\\#id1}}' '\\index{RFC@\\spxentry{RFC}!RFC 2324\\#id1@\\spxentry{RFC 2324\\#id1}}'
'\\sphinxhref{http://tools.ietf.org/html/rfc2324.html\\#id1}' '\\sphinxhref{http://datatracker.ietf.org/doc/html/rfc2324.html\\#id1}'
'{\\sphinxstylestrong{RFC 2324\\#id1}}') '{\\sphinxstylestrong{RFC 2324\\#id1}}')
), ),
( (