diff options
| author | georg.brandl <devnull@localhost> | 2008-05-03 20:15:25 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-05-03 20:15:25 +0000 |
| commit | 00c794b37a472bf0bb66914329264a6a889cbed0 (patch) | |
| tree | 7194cec8adf175ad503371c3bea6f065f2f11dbe /doc | |
| parent | f20dd9ee70bdadffba729c925d4c7d99468fcda7 (diff) | |
| download | sphinx-00c794b37a472bf0bb66914329264a6a889cbed0.tar.gz | |
Fix OpenSearch description generation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 9 | ||||
| -rw-r--r-- | doc/markup/misc.rst | 2 |
2 files changed, 8 insertions, 3 deletions
diff --git a/doc/config.rst b/doc/config.rst index 6f8ea62b..3f69c480 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -255,9 +255,12 @@ that use Sphinx' HTMLWriter class. .. 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``. + If nonempty, an `OpenSearch <http://opensearch.org>` description file will be + output, and all pages will contain a ``<link>`` tag referring to it. Since + OpenSearch doesn't support relative URLs for its search page location, the + value of this option must be the base URL from which these documents are + served (without trailing slash), e.g. ``"http://docs.python.org"``. The + default is ``''``. .. confval:: html_translator_class diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index 62ee6b67..a2135a5d 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -75,4 +75,6 @@ exists: The automatic width is determined by rendering the content in the table, and scaling them according to their share of the total width. + By default, Sphinx uses a table layout with ``L`` for every column. + .. versionadded:: 0.2.1 |