diff options
Diffstat (limited to 'doc/invocation.rst')
| -rw-r--r-- | doc/invocation.rst | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/invocation.rst b/doc/invocation.rst index c6125ecc..f831dc0a 100644 --- a/doc/invocation.rst +++ b/doc/invocation.rst @@ -124,13 +124,22 @@ The :program:`sphinx-build` script has several options: .. option:: -D setting=value Override a configuration value set in the :file:`conf.py` file. The value - must be a string or dictionary value. For the latter, supply the setting - name and key like this: ``-D latex_elements.docclass=scrartcl``. For boolean - values, use ``0`` or ``1`` as the value. + must be a number, string, list or dictionary value. + + For lists, you can separate elements with a comma like this: ``-D + html_theme_path=path1,path2``. + + For dictionary values, supply the setting name and key like this: + ``-D latex_elements.docclass=scrartcl``. + + For boolean values, use ``0`` or ``1`` as the value. .. versionchanged:: 0.6 The value can now be a dictionary value. + .. versionchanged:: 1.3 + The value can now also be a list value. + .. option:: -A name=value Make the *name* assigned to *value* in the HTML templates. @@ -140,7 +149,8 @@ The :program:`sphinx-build` script has several options: .. option:: -n Run in nit-picky mode. Currently, this generates warnings for all missing - references. + references. See the config value :confval:`nitpick_ignore` for a way to + exclude some references as "known missing". .. option:: -N @@ -269,7 +279,7 @@ The :program:`sphinx-apidoc` script has several options: filesystem to discover packages and modules. You may need it if you want to generate documentation from a source directory managed by `collective.recipe.omelette - <http://pypi.python.org/pypi/collective.recipe.omelette/>`_. + <https://pypi.python.org/pypi/collective.recipe.omelette/>`_. By default, symbolic links are skipped. .. versionadded:: 1.2 |