Only check source files that are in "found_docs" #60
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
This was referenced Aug 26, 2023
lmoureaux
reviewed
Aug 26, 2023
| @@ -276,6 +276,11 @@ def _builder_inited(app): | |||
|
|
|||
| def _source_read(app, docname, source): | |||
| env = app.env | |||
| if docname not in env.found_docs: | |||
There was a problem hiding this comment.
This doesn't work in my case when sphinx-build is called from the documentation root. The issue is that the included file is also used as a main document in the toctree. So for in-source builds, _source_read gets called as follows:
_source_read(app, "including-doc", ...) # The doc with the include
_source_read(app, "included-doc", ...) # From include
_source_read(app, "included-doc", ...) # As main documentWhen running sphinx-build from a different location, we get:
_source_read(app, "including-doc", ...) # The doc with the include
_source_read(app, "path/to/included-doc", ...) # From include
_source_read(app, "included-doc", ...) # As main document
|
Obsoleted by #61. |
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 is an alternative (and an extension) to #57.