diff options
| author | Georg Brandl <georg@python.org> | 2014-01-10 21:44:14 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-10 21:44:14 +0100 |
| commit | b4ee842d368dbf7cc8335c092ce33f3b847f8a82 (patch) | |
| tree | 45759c98852d55b1b14ebed15116738ecb7a1934 /doc/invocation.rst | |
| parent | 61760219a619244293b7f05a8a7036dae917f689 (diff) | |
| download | sphinx-b4ee842d368dbf7cc8335c092ce33f3b847f8a82.tar.gz | |
Closes #925: Allow list-typed config values to be provided on the command line,
like ``-D key=val1,val2``.
Diffstat (limited to 'doc/invocation.rst')
| -rw-r--r-- | doc/invocation.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/invocation.rst b/doc/invocation.rst index c6125ecc..4f4d81ac 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. |
