IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added the epub theme options relbar1 and footer.

Browse Source
This commit is contained in:
Roland Meister
2011-05-23 21:09:51 +02:00
parent f107cf7787
commit 0da0c03b53
6 changed files with 28 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/config.rst
View File

@@ -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

10
doc/theming.rst
View File

@@ -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
---------------