diff options
| author | Georg Brandl <georg@python.org> | 2014-01-11 08:14:55 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-11 08:14:55 +0100 |
| commit | 7ae642f2b292e85c8f934fd05a48362e9b90d3c4 (patch) | |
| tree | 2636476a5a2545aa5a2a55e8e039a7001d6bfbab /doc | |
| parent | 4238b992b5e047c00a8a94df263e64fc8d1260db (diff) | |
| parent | 778bf598128f22b4cdd913dfed27edb9eeeb20d0 (diff) | |
| download | sphinx-7ae642f2b292e85c8f934fd05a48362e9b90d3c4.tar.gz | |
merge stable into default
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 2 | ||||
| -rw-r--r-- | doc/invocation.rst | 15 | ||||
| -rw-r--r-- | doc/markup/toctree.rst | 5 |
3 files changed, 16 insertions, 6 deletions
diff --git a/doc/config.rst b/doc/config.rst index 70ccd26e..f57e9eff 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -118,7 +118,7 @@ General configuration in that case. .. deprecated:: 1.0 - Use :confval:`exclude_patterns` instead. + Use :confval:`exclude_patterns` or :ref:`metadata` instead. .. confval:: exclude_trees 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. diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst index 41c265f8..90666b72 100644 --- a/doc/markup/toctree.rst +++ b/doc/markup/toctree.rst @@ -141,8 +141,9 @@ tables of contents. The ``toctree`` directive is the central element. In the end, all documents in the :term:`source directory` (or subdirectories) must occur in some ``toctree`` directive; Sphinx will emit a warning if it finds a file that is not included, because that means that this file will not - be reachable through standard navigation. Use :confval:`exclude_patterns` to - explicitly exclude documents or directories from building. + be reachable through standard navigation. Use :ref:`metadata` to remove the + warning, and :confval:`exclude_patterns` to explicitly exclude documents or + directories from building. The "master document" (selected by :confval:`master_doc`) is the "root" of the TOC tree hierarchy. It can be used as the documentation's main page, or |
