Describe how to fix headings which begin with a number#75
Open
ScatteredComet wants to merge 3 commits intogodotengine:mainfrom
Open
Describe how to fix headings which begin with a number#75ScatteredComet wants to merge 3 commits intogodotengine:mainfrom
ScatteredComet wants to merge 3 commits intogodotengine:mainfrom
Conversation
ScatteredComet
force-pushed
the
section-headers
branch
from
9273e5d to
f23d337
Compare
Ivorforce
reviewed
Mar 4, 2026
Comment on lines
+172
to
+181
| Headers which begin with a number lead to incorrect link fragments. To workaround this, add a custom anchor before any such header: | ||
|
|
||
| .. code:: rst | ||
|
|
||
| .. _doc_2d_movement_8-way_movement: | ||
|
|
||
| 8-way movement | ||
| -------------- | ||
|
|
||
| Try to use the convention ``_doc_<page_slug>_<section_slug>:`` or, if that isn't unique, ``_doc_<page_slug>_<section_slug>_<subsection_slug>:``. The only allowed characters are alphanumeric (``A-Z``, ``a-z``, ``0-9``) and underscores (``_``). |
Member
There was a problem hiding this comment.
I used a different workaround for a digit-started header in areas.rst. I'm not sure if a single anchor will work. See https://stackoverflow.com/a/65284203/503822
Suggested by - AThousandShips - Ivorforce
Suggested by - AThousandShips
Author
|
I've added in those suggestions but as per #75 (comment) this might not even be the correct change. (The original suggestion was here) |
ScatteredComet
changed the title
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
4 participants
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.
I tried to follow the wording from here https://docutils.sourceforge.io/docs/user/rst/quickstart.html#sections
Also adds info about when custom anchors are necessary as per