Fix id names in rst renders after docutils 0.18#2081
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to stabilize reStructuredText (Docutils) HTML anchor/id generation after upgrading to Docutils 0.18 by explicitly setting auto_id_prefix to the pre-upgrade default.
Changes:
- Adds an explicit
auto_id_prefixoverride in the Docutilssettings_overridesused by therest2htmlrenderer.
Show a summary per file
| File | Description |
|---|---|
lib/github/commands/rest2html |
Overrides Docutils settings to control how automatic IDs are generated in rendered HTML. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
0f716e8 to
24f8e1f
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
9b3bdad to
d9f8ee6
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
d9f8ee6 to
5c2f877
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
5c2f877 to
e329f55
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
e329f55 to
d7b5b51
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
d7b5b51 to
d1da2c3
Compare
Contributor
Author
Fix id names changing in rst renders with the upgrade to docutils 0.18 by enforcing the old default value `id` for `auto_id_prefix`. See: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26 co-authored-by: Tyler Dixon <tylerdixon@github.com>
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
d1da2c3 to
a5d7bbe
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
a5d7bbe to
c430d21
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
c430d21 to
f0c175d
Compare
Contributor
Author
|
oh okay it's because those were running on the merge with the master branch... so i rebased on top of it instead of v6.0.0 and it's passing... |
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
f0c175d to
0b012a4
Compare
pudiva
force-pushed
the
rst-auto-id-prefix
branch
from
0b012a4 to
a5d7bbe
Compare
Contributor
Author
|
i had to base this on top of v6.0.0 because master already has unreleased changes that cause other problems for me. could someone help me figure out the right way to incorporate this change in the codebase? |
TylerDixon
approved these changes
Jul 1, 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.
Fix id names changing in rst renders with the upgrade to docutils 0.18 by enforcing the old default value for
auto_id_prefix.See: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26
co-authored-by: @TylerDixon