diff options
author | Georg Brandl <georg@python.org> | 2014-09-22 14:51:47 +0200 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2014-09-22 14:51:47 +0200 |
commit | eacb5d9cb3b68b21255fd8ebd5e3c357e631f412 (patch) | |
tree | 1b259d36d3f105e8b0971acb1f838f89110595e1 /doc | |
parent | 13ea213d7cfabc741dadd26f94b9645d3ea14b4e (diff) | |
download | sphinx-eacb5d9cb3b68b21255fd8ebd5e3c357e631f412.tar.gz |
[WIP] parallel read
Diffstat (limited to 'doc')
-rw-r--r-- | doc/extdev/appapi.rst | 3 | ||||
-rw-r--r-- | doc/extdev/index.rst | 7 |
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index f9b43560..d65f91a5 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -442,7 +442,8 @@ handlers to the events. Example: Emitted after the environment has determined the list of all added and changed files and just before it reads them. It allows extension authors to reorder the list of docnames (*inplace*) before processing, or add more - docnames that Sphinx did not consider changed. + docnames that Sphinx did not consider changed (but never add any docnames + that are not in ``env.found_docs``). You can also remove document names; do this with caution since it will make Sphinx treat changed files as unchanged. diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 481688ac..5144c5f8 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -33,6 +33,13 @@ as metadata of the extension. Metadata keys currently recognized are: * ``'version'``: a string that identifies the extension version. It is used for extension version requirement checking (see :confval:`needs_extensions`) and informational purposes. If not given, ``"unknown version"`` is substituted. +* ``'parallel_read_safe'``: a boolean that specifies if parallel reading of + 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. +* ``'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``. APIs used for writing extensions -------------------------------- |