Skip to content

Declare extension as safe for parallel reading/writing#38

Merged
liran-funaro merged 1 commit intoliran-funaro:mainfrom
krobelus:explicit-parallelism
Oct 15, 2025
Merged

Declare extension as safe for parallel reading/writing#38
liran-funaro merged 1 commit intoliran-funaro:mainfrom
krobelus:explicit-parallelism

Conversation

@krobelus
Copy link

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.

@krobelus krobelus force-pushed the explicit-parallelism branch from 1b4b096 to ae8cf57 Compare September 24, 2025 18:12
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.
@coveralls
Copy link

Pull Request Test Coverage Report for Build 18528968370

Details

  • 3 of 3 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.002%) to 99.105%

Totals Coverage Status
Change from base Build 18528888405: 0.002%
Covered Lines: 775
Relevant Lines: 782

💛 - Coveralls

Copy link
Owner

@liran-funaro liran-funaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@liran-funaro liran-funaro merged commit fd81abb into liran-funaro:main Oct 15, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants