summaryrefslogtreecommitdiff
path: root/doc/config.rst
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2008-04-27 18:08:55 +0000
committergeorg.brandl <devnull@localhost>2008-04-27 18:08:55 +0000
commitbd3f021f64c447e61c157a63d078b8e03b3dda21 (patch)
tree053d245fc46f315e578d4cf7160a8301be9b3cf6 /doc/config.rst
parentdf62fabbb9a4af76588e7fa9c8067b518f44189a (diff)
downloadsphinx-bd3f021f64c447e61c157a63d078b8e03b3dda21.tar.gz
Add OpenSearch capability.
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 7378270f..3de76e8d 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -227,7 +227,13 @@ that use Sphinx' HTMLWriter class.
.. confval:: html_copy_source
If true, the reST sources are included in the HTML build as
- :file:`_sources/{name}`.
+ :file:`_sources/{name}`. The default is ``True``.
+
+.. confval:: html_use_opensearch
+
+ If true, an `OpenSearch <http://opensearch.org>` description file will be
+ output, and all pages will contain a ``<link>`` tag referring to it.
+ The default is ``False``.
.. confval:: html_translator_class