doc: add note on unsupported include directive for source-read event content modification #10774
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
…content modification Files included with the `include` directive have their content available in the source-read event but modifications will not make it to the output, so let's document it. Closes sphinx-doc#10678 Signed-off-by: Quentin Schulz <[email protected]>
|
@AA-Turner I believe this PR can be closed now since the root issue has been resolved and fix merged into master. |
|
Or we could add a note stating that there is a limitation for included files until version X.Y. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: doc: add note on unsupported include directive for source-read event content modification
Purpose
includedirective have their content availablein the source-read event but modifications will not make it to the
output, so let's document it.
Relates
Note
Does this need to be sent to master and/or 4.x branch too?