diff options
Diffstat (limited to 'doc/man/sphinx-build.rst')
| -rw-r--r-- | doc/man/sphinx-build.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index 8be2780..ac2e7ca 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -102,8 +102,10 @@ Options .. option:: -t tag, --tag tag - Define the tag *tag*. This is relevant for :rst:dir:`only` directives that - only include their content if this tag is set. + Define the tag *tag*. + This is relevant for :rst:dir:`only` directives that + include their content only if certain tags are set. + See :ref:`including content based on tags <tags>` for further detail. .. versionadded:: 0.6 @@ -126,7 +128,7 @@ Options Distribute the build over *N* processes in parallel, to make building on multiprocessor machines more effective. Note that not all parts and not all builders of Sphinx can be parallelized. If ``auto`` argument is given, - Sphinx uses the number of CPUs as *N*. + Sphinx uses the number of CPUs as *N*. Defaults to 1. .. versionadded:: 1.2 This option should be considered *experimental*. @@ -192,7 +194,7 @@ Options .. option:: -n, --nitpicky - Run in nit-picky mode. Currently, this generates warnings for all missing + Run in nitpicky mode. Currently, this generates warnings for all missing references. See the config value :confval:`nitpick_ignore` for a way to exclude some references as "known missing". |