Skip to content

DOC Mark add_toctree_function safe for parallel read and write#18123

Merged
thomasjpfan merged 1 commit intoscikit-learn:masterfrom
cmarmo:doc_parallel_safe
Aug 8, 2020
Merged

DOC Mark add_toctree_function safe for parallel read and write#18123
thomasjpfan merged 1 commit intoscikit-learn:masterfrom
cmarmo:doc_parallel_safe

Conversation

@cmarmo
Copy link
Copy Markdown
Contributor

@cmarmo cmarmo commented Aug 8, 2020

What does this implement/fix? Explain your changes.

Running Sphinx v3.2.0 to build the documentation throws the following warning

WARNING: the add_toctree_functions 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
WARNING: doing serial read

This PR marks the add_toctree_functions extension as safe for parallel reading and writing, allowing parallel building: see sphinx extension metadata for more details and the same issue in readthedocs sphinx theme.

Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thank you @cmarmo !

@thomasjpfan thomasjpfan changed the title DOC Mark the add_toctree_functions extension as safe for parallel reading and writing. DOC Mark add_toctree_function safe for parallel read and write Aug 8, 2020
@thomasjpfan thomasjpfan merged commit 173cf53 into scikit-learn:master Aug 8, 2020
@cmarmo cmarmo deleted the doc_parallel_safe branch August 8, 2020 20:57
jayzed82 pushed a commit to jayzed82/scikit-learn that referenced this pull request Oct 22, 2020
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.

2 participants