Repository navigation
Add a local documentation server - #4936
Merged
Merged
Conversation
bdbaddog
reviewed
Oct 19, 2026
For a long time, it's been a pain to view the generated API docs, as the links don't work right. This change lets you start a tiny http server during development, a similar concept to what has long been available for the scons-website project. Use "scons serve-docs" and "scons stop-docs" to start/stop the server. It will tell you the links to go to, assuming they already exist, so the usage model is Build docs -> start server -> view. This change was AI-assisted. 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
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.
For a long time, it's been a pain to view the generated API docs, as the links don't work right. This change lets you start a tiny http server during development, a similar concept to what has long been available for the scons-website project. Use
scons serve-docsandscons stop-docsto start/stop the server. It will tell you the links to go to, assuming they already exist, so the usage model is Build docs -> start server -> view.This change was AI-assisted.
No changes to SCons or its tests.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).