diff options
| author | Roland Meister <devnull@localhost> | 2011-05-23 21:09:51 +0200 |
|---|---|---|
| committer | Roland Meister <devnull@localhost> | 2011-05-23 21:09:51 +0200 |
| commit | 5c554a7fa41ff11ae8c80ff7eb451bb60e8ab3c3 (patch) | |
| tree | 624f4e1331ec5bbcbc924f80316980cf21c4141c /doc | |
| parent | 49407811d99090faf78a861c7871b5f58570b3a6 (diff) | |
| download | sphinx-5c554a7fa41ff11ae8c80ff7eb451bb60e8ab3c3.tar.gz | |
Added the epub theme options relbar1 and footer.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 6 | ||||
| -rw-r--r-- | doc/theming.rst | 12 |
2 files changed, 14 insertions, 4 deletions
diff --git a/doc/config.rst b/doc/config.rst index 98b8a0cf..649490cd 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -770,6 +770,12 @@ the `Dublin Core metadata <http://dublincore.org/>`_. output is usually not wise. This defaults to ``'epub'``, a theme designed to save visual space. +.. confval:: epub_theme_options + + A dictionary of options that influence the look and feel of the selected + theme. These are theme-specific. For the options understood by the builtin + themes, see :ref:`this section <builtin-themes>`. + .. confval:: epub_title The title of the document. It defaults to the :confval:`html_title` option diff --git a/doc/theming.rst b/doc/theming.rst index 802b211f..334f6ffe 100644 --- a/doc/theming.rst +++ b/doc/theming.rst @@ -200,10 +200,14 @@ These themes are: * **traditional** -- A theme resembling the old Python documentation. There are currently no options beyond *nosidebar* and *sidebarwidth*. -* **epub** -- A theme for the epub builder. There are currently no options. - This theme tries to save visual space which is a sparse resource on ebook - readers. - +* **epub** -- A theme for the epub builder. This theme tries to save visual + space which is a sparse resource on ebook readers. The following options + are supported: + + - **relbar1** (true or false, default true): If this is true, the + `relbar1` block is inserted in the epub output, otherwise it is omitted. + - **footer** (true or false, default true): If this is true, the + `footer` block is inserted in the epub output, otherwise it is ommitted. Creating themes --------------- |