Add remaining links to User Guide sections #4764
Merged
Conversation
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
All section tags in User Guide now have id="some-tag" (many using editor autocomplete). Roughly half had previously been converted. This elminates obscure numeric auto- generated references in the output that look like: https://scons.org/doc/production/HTML/scons-user.html#id1514 Signed-off-by: Mats Wichmann <[email protected]>
mwichmann
changed the title
bdbaddog
reviewed
Sep 24, 2025
CHANGES.txt
Outdated
| for known exception types. | ||
| - TEMPFILE: Fix the tempfile encoding test regex strings to eliminate | ||
| warnings in python 3.12 and 3.13. | ||
| - Add tags to the remaining section headers in the User Guide. This is |
There was a problem hiding this comment.
Looks like you put this in jcbrill's contributions? Is that an error?
Can you also add to RELEASE.txt?
Otherwise looks good to me.
There was a problem hiding this comment.
Yeah, good catch. updated.
Signed-off-by: Mats Wichmann <[email protected]>
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.
All
<section>tags in User Guide now have anid="some-tag"(many generated by editor autocomplete). Roughly half had previously been converted. This elminates obscure numeric auto- generated non-constant references in the output that look like:https://scons.org/doc/production/HTML/scons-user.html#id1514
The old way, any time a section is added, all sections following in the processing order would renumber the auto-generated anchor.
Involves no SCons code changes.
Doc contents don't change either. Added one link to one appendix chapter - but that chapter is not included in the Guide at the moment, Two previously added tags, that were actually linked to, don't follow the naming convention I've been using, so those were adjusted at both the definition and the link location.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).