Fix problem where API doc gen misses some files #3292
Merged
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.
In
doc/SConscript
, the function inbootstrap.py
to parse a manifest was called with an scons path (#src/engine
) but bootstrap does not run in an scons context, it is run viasubprocess.Popen
. As a result, the glob matching failed to match files. The resulting list is passed toepydoc
(at the moment) to generate the API docs, so the list should be correct (it was actually missing very little, since 14 of the missed files are later eliminated when the list is cleaned)Preprocess the path before the call. Along the way, change the function to open the file itself instead of being passed a list already read from the file, update the comment, and clean some whitespace issues.
Did not updates src/CHANGES.txt since there was no change to scons source.
Signed-off-by: Mats Wichmann [email protected]
Contributor Checklist:
master/src/CHANGES.txt
directory (and read theREADME.txt
in that directory)