mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-09-03 20:52:55 -05:00
Closes #925: Allow list-typed config values to be provided on the command line,
like ``-D key=val1,val2``.
This commit is contained in:
+12
-3
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user