Collect doc files based primarily on an inclusion list #9947
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
dhalbert
requested changes
Jan 10, 2025
Collaborator
dhalbert
left a comment
dhalbert
left a comment
There was a problem hiding this comment.
The stubs build failed in the docs build
Author
|
serves me right for messing with two things. |
It frequently arises that files were inadvertently included in the doc build, because it was based on a series of exclude patterns, but new filenames that don't match the exclude patterns are frequently created by new build systems, new submodules, un-tidy developer source trees, etc. So, use include_patterns as a set of positive patterns, then weed out a few specific items that otherwise match the include patterns.
jepler
force-pushed
the
sphinx-prefer-include-list
branch
from
9d87e06 to
5be0974
Compare
Author
|
Updated to just include the include-list change. |
dhalbert
approved these changes
Jan 10, 2025
Collaborator
dhalbert
left a comment
dhalbert
left a comment
There was a problem hiding this comment.
Looks good! I looked up some things in the doc artifact and they looked fine.
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.
It frequently arises that files were inadvertently included in the doc build, because it was based on a series of exclude patterns, but new filenames that don't match the exclude patterns are frequently created by new build systems, new submodules, un-tidy developer source trees, etc.
So, use include_patterns as a set of positive patterns, then weed out a few specific items that otherwise match the include patterns.
This also fixes a diagnostic printed by setuptools_scm duringmake stubsormake htmlabout incorrect configuration.Testing performed:
make htmlbefore & after these changes & compared the list of generated html files. The filenames matched. I didn't compare the file content.