mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge pull request #9050 from tk0miya/8829_whats_parallel_read_safe
Close #8829: doc: Update description of paralle-read-safe
This commit is contained in:
commit
8ec937d4c9
@ -171,10 +171,26 @@ as metadata of the extension. Metadata keys currently recognized are:
|
||||
source files can be used when the extension is loaded. It defaults to
|
||||
``False``, i.e. you have to explicitly specify your extension to be
|
||||
parallel-read-safe after checking that it is.
|
||||
|
||||
.. note:: The *parallel-read-safe* extension must satisfy the following
|
||||
conditions:
|
||||
|
||||
* The core logic of the extension is parallely executable during
|
||||
the reading phase.
|
||||
* It has event handlers for :event:`env-merge-info` and
|
||||
:event:`env-purge-doc` events if it stores dataa to the build
|
||||
environment object (env) during the reading phase.
|
||||
|
||||
* ``'parallel_write_safe'``: a boolean that specifies if parallel writing of
|
||||
output files can be used when the extension is loaded. Since extensions
|
||||
usually don't negatively influence the process, this defaults to ``True``.
|
||||
|
||||
.. note:: The *parallel-write-safe* extension must satisfy the following
|
||||
conditions:
|
||||
|
||||
* The core logic of the extension is parallely executable during
|
||||
the writing phase.
|
||||
|
||||
|
||||
APIs used for writing extensions
|
||||
--------------------------------
|
||||
|
Loading…
Reference in New Issue
Block a user