summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2008-06-17 09:01:26 +0000
committergeorg.brandl <devnull@localhost>2008-06-17 09:01:26 +0000
commitc45ee96c567e0dbc8ba878dbfda68b8bc6b0c4fa (patch)
tree7cf4f4c503a972538ea5ea8670ac1ff957448475 /doc
parent3a1f414240e26776d0e434dcc7d88aa5c503ac63 (diff)
downloadsphinx-c45ee96c567e0dbc8ba878dbfda68b8bc6b0c4fa.tar.gz
Support splitting the HTML index.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
index baf2b758..2cbe850c 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -287,6 +287,13 @@ that use Sphinx' HTMLWriter class.
.. versionadded:: 0.4
+.. confval:: html_split_index
+
+ If true, the index is generated twice: once as a single page with all the
+ entries, and once as one page per starting letter. Default is ``False``.
+
+ .. versionadded:: 0.4
+
.. confval:: html_copy_source
If true, the reST sources are included in the HTML build as