Support "source-read" being emitted for included docs #57
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
Since Sphinx 7.2, the "source-read" event is emitted for included documents (.. include directive). A document can be included multiple times, and thus the hook cannot assume that it's called only once per docname. An issue in Sphinx itself affects the extension when using included documents. Add a warning in the README.
lmoureaux
force-pushed
the
bugfix/sphinx-7.2-include
branch
from
9d74e45 to
f65a9d2
Compare
lmoureaux
added a commit
to lmoureaux/freeciv21
that referenced
this pull request
Aug 25, 2023
This is a short-term solution for longturn#2023. In the long run, upstream issues should be fixed: * sphinx-doc/sphinx#11643 * mgeier/sphinx-last-updated-by-git#57 Closes longturn#2023.
|
Thanks for this PR! I'm trying to fix the failing CI before merging this. First step is #58, but there are still errors happening ... |
|
With #59 the CI passes, but I'm not sure if that's the right thing to do. |
|
I've created a different work-around in #60, which should fix the problem regardless of the directory where Sphinx is called. |
jwrober
pushed a commit
to longturn/freeciv21
that referenced
this pull request
Aug 26, 2023
This is a short-term solution for #2023. In the long run, upstream issues should be fixed: * sphinx-doc/sphinx#11643 * mgeier/sphinx-last-updated-by-git#57 Closes #2023.
|
Thanks again @lmoureaux for working on this! I have just created new release, which hopefully fixes the problem. |
lmoureaux
added a commit
to longturn/freeciv21
that referenced
this pull request
Nov 23, 2023
This is a short-term solution for #2023. In the long run, upstream issues should be fixed: * sphinx-doc/sphinx#11643 * mgeier/sphinx-last-updated-by-git#57 Closes #2023.
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.
Since Sphinx 7.2, the "source-read" event is emitted for included documents (.. include directive). A document can be included multiple times, and thus the hook cannot assume that it's called only once per docname.
An issue in Sphinx itself affects the extension when using included documents. Add a warning in the README.