diff options
| author | Georg Brandl <georg@python.org> | 2010-05-24 23:14:35 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-05-24 23:14:35 +0200 |
| commit | 497376f86c7a82e91c4e1ceaa00a5ca2ef9ce3ae (patch) | |
| tree | 9445a405bf26cdb847ffd5cb64d33c20d9ad2cb0 /doc | |
| parent | 497a609be5d146b753f378cefd5202f3edf81097 (diff) | |
| download | sphinx-497376f86c7a82e91c4e1ceaa00a5ca2ef9ce3ae.tar.gz | |
In the default theme, the sidebar can experimentally now be made collapsible using the new ``collapsiblesidebar`` theme option.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 3 | ||||
| -rw-r--r-- | doc/theming.rst | 5 |
2 files changed, 7 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py index b268a13f..e009fa1b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -18,7 +18,8 @@ version = sphinx.__released__ release = version show_authors = True -html_theme = 'sphinxdoc' +html_theme = 'default' +html_theme_options = {'collapsiblesidebar': True, 'stickysidebar': False} modindex_common_prefix = ['sphinx.'] html_static_path = ['_static'] html_index = 'index.html' diff --git a/doc/theming.rst b/doc/theming.rst index ca6e8b2d..fc8ef236 100644 --- a/doc/theming.rst +++ b/doc/theming.rst @@ -105,6 +105,11 @@ These themes are: doesn't scroll out of view for long body content. This may not work well with all browsers. Defaults to false. + - **collapsiblesidebar** (true or false): Add an *experimental* JavaScript + snippet that makes the sidebar collapsible via a button on its side. + *Doesn't work together with "rightsidebar" or "stickysidebar".* Defaults to + false. + - **externalrefs** (true or false): Display external links differently from internal links. Defaults to false. |