diff options
Diffstat (limited to 'doc/theming.rst')
| -rw-r--r-- | doc/theming.rst | 94 |
1 files changed, 89 insertions, 5 deletions
diff --git a/doc/theming.rst b/doc/theming.rst index d1d3b27a..3a00150b 100644 --- a/doc/theming.rst +++ b/doc/theming.rst @@ -52,17 +52,50 @@ file :file:`blue.zip`, you can put it right in the directory containing Builtin themes -------------- -Sphinx comes with a selection of themes to choose from: +.. cssclass:: right + ++--------------------+--------------------+ +| **Theme overview** | | ++--------------------+--------------------+ +| |default| | |sphinxdoc| | +| | | +| *default* | *sphinxdoc* | ++--------------------+--------------------+ +| |scrolls| | |agogo| | +| | | +| *scrolls* | *agogo* | ++--------------------+--------------------+ +| |traditional| | |nature| | +| | | +| *traditional* | *nature* | ++--------------------+--------------------+ +| |haiku| | | +| | | +| *haiku* | | ++--------------------+--------------------+ + +.. |default| image:: themes/default.png +.. |sphinxdoc| image:: themes/sphinxdoc.png +.. |scrolls| image:: themes/scrolls.png +.. |agogo| image:: themes/agogo.png +.. |traditional| image:: themes/traditional.png +.. |nature| image:: themes/nature.png +.. |haiku| image:: themes/haiku.png + +Sphinx comes with a selection of themes to choose from. + +These themes are: * **basic** -- This is a basically unstyled layout used as the base for the - *default* and *sphinxdoc* themes, and usable as the base for custom themes as - well. The HTML contains all important elements like sidebar and relation bar. - There is one option (which is inherited by *default* and *sphinxdoc*): + other themes, and usable as the base for custom themes as well. The HTML + contains all important elements like sidebar and relation bar. There is one + option (which is inherited by the other themes): - **nosidebar** (true or false): Don't include the sidebar. Defaults to false. -* **default** -- This is the default theme. It can be customized via these +* **default** -- This is the default theme, which looks like `the Python + documentation <http://docs.python.org/>`_. It can be customized via these options: - **rightsidebar** (true or false): Put the sidebar on the right side. @@ -86,6 +119,7 @@ Sphinx comes with a selection of themes to choose from: - **bgcolor** (CSS color): Body background color. - **textcolor** (CSS color): Body text color. - **linkcolor** (CSS color): Body link color. + - **visitedlinkcolor** (CSS color): Body color for visited links. - **headbgcolor** (CSS color): Background color for headings. - **headtextcolor** (CSS color): Text color for headings. - **headlinkcolor** (CSS color): Link color for headings. @@ -99,9 +133,59 @@ Sphinx comes with a selection of themes to choose from: * **sphinxdoc** -- The theme used for this documentation. It features a sidebar on the right side. There are currently no options beyond *nosidebar*. +* **scrolls** -- A more lightweight theme, based on `the Jinja documentation + <http://jinja.pocoo.org/2/documentation/>`_. The following color options are + available: + + - **headerbordercolor** + - **subheadlinecolor** + - **linkcolor** + - **visitedlinkcolor** + - **admonitioncolor** + +* **agogo** -- A theme created by Andi Albrecht. The following options are + supported: + + - **bodyfont** (CSS font family): Font for normal text. + - **headerfont** (CSS font family): Font for headings. + - **pagewidth** (CSS length): Width of the page content, default 70em. + - **documentwidth** (CSS length): Width of the document (without sidebar), + default 50em. + - **sidebarwidth** (CSS length): Width of the sidebar, default 20em. + - **bgcolor** (CSS color): Background color. + - **headerbg** (CSS value for "background"): background for the header area, + default a grayish gradient. + - **footerbg** (CSS value for "background"): background for the footer area, + default a light gray gradient. + - **linkcolor** (CSS color): Body link color. + - **headercolor1**, **headercolor2** (CSS color): colors for <h1> and <h2> + headings. + - **headerlinkcolor** (CSS color): Color for the backreference link in + headings. + - **textalign** (CSS *text-align* value): Text alignment for the body, default + is ``justify``. + +* **nature** -- A greenish theme. There are currently no options beyond + *nosidebar*. + +* **haiku** -- A theme without sidebar inspired by the `Haiku OS user guide + <http://www.haiku-os.org/docs/userguide/en/contents.html>`_. The following + options are supported: + + - **full_logo** (true or false, default false): If this is true, the header + will only show the :confval:`html_logo`. Use this for large logos. If this + is false, the logo (if present) will be shown floating right, and the + documentation title will be put in the header. + - **textcolor**, **headingcolor**, **linkcolor**, **visitedlinkcolor**, + **hoverlinkcolor** (CSS colors): Colors for various body elements. + * **traditional** -- A theme resembling the old Python documentation. There are currently no options beyond *nosidebar*. +* **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. + Creating themes --------------- |