DM-44137: Add extend_excludes_for_non_index_source #224
Conversation
This file contains 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
jonathansick
force-pushed
the
tickets/DM-44137
branch
from
7b93031 to
76babb7
Compare
This configuration function is for technotes to exclude rst, md, and ipynb files that aren't the index file.
Although this is a private API, its useful for the lssttasks extension. We'll need to revisit this if the API does prove to be too unstable to use in our own purpose.
Sphinx clarifies that this should be a literal type not, not a boolean in general.
jonathansick
force-pushed
the
tickets/DM-44137
branch
from
76babb7 to
e2b6b98
Compare
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.
This configuration function is for technotes to exclude rst, md, and ipynb files that aren't the index file. Also includes small fixes due to updates in Sphinx:
Bug fixes
Technotes ignore files in the repository with
.md,.rst, and.ipynbextensions if they aren't the index file. Since technotes are single-page documents, only the index file should be used as a source file. This change lets authors include auxillary notebooks with their technotes without having to explicitly exclude them from the technote build process. This is implemented withtechnote.conf.extend_excludes_for_non_index_source.In
documenteer.ext.lssttasks, attempt to import_pseudo_parse_arglistfromsphinx.domains.python._annotationsbefore falling back to thesphinx.domains.pythonmodule. Ultimately this is a workaround.Fix setting the rebuild condition for the
documenteer.ext.githubbibcacheextension.Other changes
defusedxmlas a dev dependency. This is used by Sphinx'ssphinx.testing.fixtures, but isn't included as a dependency by Sphinx itself. This change ensures thatdefusedxmlis installed when running the tests.