Conversation
This was referenced Sep 19, 2026
Author
|
The failures are flakey tests and the missing changes from #14681. I keep them separate, as they solve different issues, merging the two would resolve the Docutils HEAD failures and the LaTeX failures. |
This branch has not been deployed
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
Hej,
this updates the
:rfc:role to use the canonical RFC Editor URL.I was double checking if #14681 was enough to really fix all CI, as mentioned in #14677 but with new changes landing in upstream Docutils, this was no longer true, so here now the fixes to the newest 4 CI failures.
Sphinx currently provides its own
rfc_base_urlbut uses DocutilsInliner.rfc_urltemplate for the remaining path.This makes generated URLs depend on the installed Docutils version: released version uses
rfc%d.html, while current Docutils development versions userfc%d/.So, the same Sphinx version can generate different RFC URLs depending only on the installed Docutils version.
Combining the new RFC Editor base URL with the template from a released Docutils version would also produce
/info/rfcNNNN.html, which is not a valid RFC Editor URL.To fix this cleanly and decouple Sphinx a bit, Sphinx now constructs the
rfcNNNN/portion itself. This keeps RFC URLs consistent across supported and development Docutils versions while continuing to respect the configurablerfc_base_url.The default base URL is changed from
https://datatracker.ietf.org/doc/html/to the canonicalhttps://www.rfc-editor.org/info/.Focused regression tests cover plain RFC references, section anchors, empty anchors, custom base URLs, HTML output, and LaTeX output.
The environment version is incremented so existing cached doctrees are rebuilt with the new URLs.
The declared
docutils>=0.21,<0.23dependency range is unchanged.References
AI Disclosure
OpenAI Codex assisted with reviewing the implementation, analyzing compatibility with released and development Docutils versions. All AI-assisted work was reviewed and understood by me.