IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Further minor copyediting of the 'extension metadata' section

Browse Source
This commit is contained in:
Adam Turner 2025-01-10 01:26:17 +00:00
parent daade2715a
commit d42cfa702f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/extdev/index.rst
View File

@ -164,13 +164,13 @@ This is treated by Sphinx as metadata of the extension.
Metadata keys currently recognized are: Metadata keys currently recognized are:
``'version'`` ``'version'``
a string that identifies the extension version. A string that identifies the extension version.
It is used for extension version requirement checking It is used for extension version requirement checking
(see :confval:`needs_extensions`) and informational purposes. (see :confval:`needs_extensions`) and informational purposes.
If not given, ``"unknown version"`` is substituted. If no version string is returned, ``'unknown version'`` is used by default.
``'env_version'`` ``'env_version'``
a non-zero positive integer integer that records A non-zero positive integer integer that records
the version of data stored in the environment by the extension. the version of data stored in the environment by the extension.
.. attention:: .. attention::
@ -185,7 +185,7 @@ Metadata keys currently recognized are:
.. versionadded:: 1.8 .. versionadded:: 1.8
``'parallel_read_safe'`` ``'parallel_read_safe'``
a boolean that specifies if parallel reading of source files A boolean that specifies if parallel reading of source files
can be used when the extension is loaded. can be used when the extension is loaded.
It defaults to ``False``, meaning that you have to explicitly specify It defaults to ``False``, meaning that you have to explicitly specify
your extension to be safe for parallel reading after checking that it is. your extension to be safe for parallel reading after checking that it is.
@ -202,7 +202,7 @@ Metadata keys currently recognized are:
environment object (``env``) during the reading phase. environment object (``env``) during the reading phase.
``'parallel_write_safe'`` ``'parallel_write_safe'``
a boolean that specifies if parallel writing of output files A boolean that specifies if parallel writing of output files
can be used when the extension is loaded. can be used when the extension is loaded.
Since extensions usually don't negatively influence the process, Since extensions usually don't negatively influence the process,
this defaults to ``True``. this defaults to ``True``.