Declare extension as safe for parallel reading/writing#38
Merged
liran-funaro merged 1 commit intoliran-funaro:mainfrom Oct 15, 2025
Merged
Declare extension as safe for parallel reading/writing#38liran-funaro merged 1 commit intoliran-funaro:mainfrom
liran-funaro merged 1 commit intoliran-funaro:mainfrom
Conversation
1b4b096 to
ae8cf57
Compare
krobelus
added a commit
to krobelus/fish-shell
that referenced
this pull request
Sep 26, 2025
We get a warning about sphinx_markdown_builder not being parallelizable. Fix that. Ref: liran-funaro/sphinx-markdown-builder#38
krobelus
added a commit
to fish-shell/fish-shell
that referenced
this pull request
Sep 27, 2025
We get a warning about sphinx_markdown_builder not being parallelizable. Fix that. Ref: liran-funaro/sphinx-markdown-builder#38 (cherry picked from commit e6541c5)
When I run sphinx-build with "-j auto" I get this warning: WARNING: the sphinx_markdown_builder extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit Based on https://www.sphinx-doc.org/en/master/extdev/index.html and a cursory look at the code, I think we should be parallel-safe: concurrent read/write calls on different documents should not conflict, and we never write anything to the build environment object ("env"). Let's enable parallel reading/writing explicitly. If this is wrong, we should disable it explicitly.
ae8cf57 to
e11652c
Compare
Pull Request Test Coverage Report for Build 18528968370Details
💛 - Coveralls |
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
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.
When I run sphinx-build with "-j auto" I get this warning:
Based on https://www.sphinx-doc.org/en/master/extdev/index.html and
a cursory look at the code, I think we should be parallel-safe:
concurrent read/write calls on different documents should not conflict,
and we never write anything to the build environment object ("env").
Let's enable parallel reading/writing explicitly.
If this is wrong, we should disable it explicitly.