summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-11-16 14:48:52 +0100
committerGeorg Brandl <georg@python.org>2009-11-16 14:48:52 +0100
commit9977822f3b4e52cdc02469334094fd110f0b0d43 (patch)
treebe0c964aa24e806d9ecdb79b631ab2f139b8e037 /doc
parent4e8368b5ffb6b968daa114fec655ea34bacf82af (diff)
downloadsphinx-9977822f3b4e52cdc02469334094fd110f0b0d43.tar.gz
Add new theme "agogo", by Andi Albrecht.
Diffstat (limited to 'doc')
-rw-r--r--doc/_templates/layout.html7
-rw-r--r--doc/themes/agogo.pngbin0 -> 36780 bytes
-rw-r--r--doc/themes/default.pngbin0 -> 52880 bytes
-rw-r--r--doc/themes/fullsize/agogo.pngbin0 -> 75005 bytes
-rw-r--r--doc/themes/fullsize/default.pngbin0 -> 96831 bytes
-rw-r--r--doc/themes/fullsize/scrolls.pngbin0 -> 121464 bytes
-rw-r--r--doc/themes/fullsize/sphinxdoc.pngbin0 -> 99682 bytes
-rw-r--r--doc/themes/fullsize/traditional.pngbin0 -> 108985 bytes
-rw-r--r--doc/themes/scrolls.pngbin0 -> 40215 bytes
-rw-r--r--doc/themes/sphinxdoc.pngbin0 -> 41680 bytes
-rw-r--r--doc/themes/traditional.pngbin0 -> 46483 bytes
-rw-r--r--doc/theming.rst48
12 files changed, 54 insertions, 1 deletions
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
index 080c0935..aa33576a 100644
--- a/doc/_templates/layout.html
+++ b/doc/_templates/layout.html
@@ -1,5 +1,12 @@
{% extends "!layout.html" %}
+{% block extrahead %}
+<style type="text/css">
+ table.right { float: right; margin-left: 20px; }
+ table.right td { border: 1px solid #ccc; }
+</style>
+{% endblock %}
+
{% block rootrellink %}
<li><a href="{{ pathto('index') }}">Sphinx home</a>&nbsp;|&nbsp;</li>
<li><a href="{{ pathto('contents') }}">Documentation</a>&raquo;</li>
diff --git a/doc/themes/agogo.png b/doc/themes/agogo.png
new file mode 100644
index 00000000..7afc4a13
--- /dev/null
+++ b/doc/themes/agogo.png
Binary files differ
diff --git a/doc/themes/default.png b/doc/themes/default.png
new file mode 100644
index 00000000..be821b67
--- /dev/null
+++ b/doc/themes/default.png
Binary files differ
diff --git a/doc/themes/fullsize/agogo.png b/doc/themes/fullsize/agogo.png
new file mode 100644
index 00000000..93fadfcb
--- /dev/null
+++ b/doc/themes/fullsize/agogo.png
Binary files differ
diff --git a/doc/themes/fullsize/default.png b/doc/themes/fullsize/default.png
new file mode 100644
index 00000000..b6af8bc3
--- /dev/null
+++ b/doc/themes/fullsize/default.png
Binary files differ
diff --git a/doc/themes/fullsize/scrolls.png b/doc/themes/fullsize/scrolls.png
new file mode 100644
index 00000000..7d46f7ed
--- /dev/null
+++ b/doc/themes/fullsize/scrolls.png
Binary files differ
diff --git a/doc/themes/fullsize/sphinxdoc.png b/doc/themes/fullsize/sphinxdoc.png
new file mode 100644
index 00000000..722fb900
--- /dev/null
+++ b/doc/themes/fullsize/sphinxdoc.png
Binary files differ
diff --git a/doc/themes/fullsize/traditional.png b/doc/themes/fullsize/traditional.png
new file mode 100644
index 00000000..103fd3ca
--- /dev/null
+++ b/doc/themes/fullsize/traditional.png
Binary files differ
diff --git a/doc/themes/scrolls.png b/doc/themes/scrolls.png
new file mode 100644
index 00000000..e4cb9aa9
--- /dev/null
+++ b/doc/themes/scrolls.png
Binary files differ
diff --git a/doc/themes/sphinxdoc.png b/doc/themes/sphinxdoc.png
new file mode 100644
index 00000000..2d2723a8
--- /dev/null
+++ b/doc/themes/sphinxdoc.png
Binary files differ
diff --git a/doc/themes/traditional.png b/doc/themes/traditional.png
new file mode 100644
index 00000000..535213fe
--- /dev/null
+++ b/doc/themes/traditional.png
Binary files differ
diff --git a/doc/theming.rst b/doc/theming.rst
index 5b4b648c..a6cf9594 100644
--- a/doc/theming.rst
+++ b/doc/theming.rst
@@ -52,7 +52,33 @@ 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| | |
+| | |
+| *traditional* | |
++--------------------+--------------------+
+
+.. |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
+
+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
@@ -103,6 +129,26 @@ Sphinx comes with a selection of themes to choose from:
* **traditional** -- A theme resembling the old Python documentation. There are
currently no options beyond *nosidebar*.
+* **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.
+
Creating themes
---------------