Update docs for SConsDoc and SConsExample#4707
Merged
bdbaddog merged 2 commits intoSCons:masterfrom Apr 11, 2025
Merged
Conversation
Both now have docstrings that render reasonably with Sphinx, in anticipation of possibly adding these files into the "API Docs" build, since they're used by developers, even if not part of SCons code itself. Signed-off-by: Mats Wichmann <mats@linux.com>
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
2 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.
Both now have docstrings that render reasonably with Sphinx, in anticipation of possibly adding these files into the "API Docs" build, since they're used by developers, even if not part of SCons code itself.
There are no changes to SCons code, this affects only the tooling around building the documentation.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).