Skip to content

Mark the extension as safe for parallel reading and writing#874

Merged
Blendify merged 2 commits intoreadthedocs:masterfrom
p12tic:enable-parallel-read-write
Feb 23, 2020
Merged

Mark the extension as safe for parallel reading and writing#874
Blendify merged 2 commits intoreadthedocs:masterfrom
p12tic:enable-parallel-read-write

Conversation

@p12tic
Copy link
Copy Markdown
Contributor

@p12tic p12tic commented Jan 30, 2020

This allows projects that use this theme to enable parallel building of documentation.

See http://www.sphinx-doc.org/en/stable/extdev/#extension-metadata for more details.

Tested on the documentation of the BuildBot project which produces 10MB of identical HTML files in both parallel and sequencial sphinx modes.

@Blendify
Copy link
Copy Markdown
Member

Blendify commented Jan 30, 2020

This is for sphinx extensions and not themes, the theme does not register a sphinx extension so I do not think this is required?

@p12tic
Copy link
Copy Markdown
Contributor Author

p12tic commented Jan 30, 2020 •
edited
Loading

We do register the theme as an extension. From the README.rst:

...
extensions = [
    ...
    "sphinx_rtd_theme",
]
...

When I build the documentation using sphinx-build -j<number_of_jobs> it breaks pointing out that the theme does not mark itself as safe for parallel processing.

@p12tic
Copy link
Copy Markdown
Contributor Author

p12tic commented Jan 30, 2020 •
edited
Loading 

the sphinx_rtd_theme 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

This is the error coming from sphinx-build.

@p12tic p12tic mentioned this pull request Jan 31, 2020
Merged
@Blendify
Copy link
Copy Markdown
Member

Blendify commented Feb 1, 2020

Ah, it seems this changed when translations were added. My bad!

@Blendify Blendify merged commit dfec3b7 into readthedocs:master Feb 23, 2020
@p12tic p12tic deleted the enable-parallel-read-write branch February 23, 2020 17:48
@p12tic p12tic mentioned this pull request Jun 13, 2020
Closed
@cmarmo cmarmo mentioned this pull request Aug 8, 2020
Merged
@pllim pllim mentioned this pull request Sep 4, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Blendify Blendify Blendify approved these changes

@agjohnson agjohnson Awaiting requested review from agjohnson

@davidfischer davidfischer Awaiting requested review from davidfischer

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@p12tic @Blendify