summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-01-07 19:19:58 +0100
committerGeorg Brandl <georg@python.org>2010-01-07 19:19:58 +0100
commit51261adf4a87e8e70838fd59fe51b031147a0d5a (patch)
tree2b356df7daeca84fa324bd69ae4e84cff7240ed2 /doc
parentbd97c900b5e07ad26393cdca2df38944c974eeee (diff)
parent995e1df9e1ca485f9b1b690fbb64bfc3d544f563 (diff)
downloadsphinx-51261adf4a87e8e70838fd59fe51b031147a0d5a.tar.gz
merge with trunk
Diffstat (limited to 'doc')
-rw-r--r--doc/concepts.rst4
-rw-r--r--doc/ext/appapi.rst10
-rw-r--r--doc/themes/fullsize/nature.pngbin0 -> 44469 bytes
-rw-r--r--doc/themes/nature.pngbin0 -> 40786 bytes
-rw-r--r--doc/theming.rst8
5 files changed, 15 insertions, 7 deletions
diff --git a/doc/concepts.rst b/doc/concepts.rst
index 212b4c7c..6f7967cf 100644
--- a/doc/concepts.rst
+++ b/doc/concepts.rst
@@ -133,8 +133,8 @@ tables of contents. The ``toctree`` directive is the central element.
In the end, all documents in the :term:`source directory` (or subdirectories)
must occur in some ``toctree`` directive; Sphinx will emit a warning if it
finds a file that is not included, because that means that this file will not
- be reachable through standard navigation. Use :confval:`unused_documents` to
- explicitly exclude documents from building, and :confval:`exclude_dirs` to
+ be reachable through standard navigation. Use :confval:`unused_docs` to
+ explicitly exclude documents from building, and :confval:`exclude_trees` to
exclude whole directories.
The "master document" (selected by :confval:`master_doc`) is the "root" of
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst
index 754f22eb..7ed3d3d4 100644
--- a/doc/ext/appapi.rst
+++ b/doc/ext/appapi.rst
@@ -56,9 +56,11 @@ the following public API:
given as keyword arguments: the keyword must be one or more of ``'html'``,
``'latex'``, ``'text'``, the value a 2-tuple of ``(visit, depart)`` methods.
``depart`` can be ``None`` if the ``visit`` function raises
- :exc:`docutils.nodes.SkipNode`. Example::
+ :exc:`docutils.nodes.SkipNode`. Example:
- class math(docutils.nodes.Element)
+ .. code-block:: python
+
+ class math(docutils.nodes.Element): pass
def visit_math_html(self, node):
self.body.append(self.starttag(node, 'math'))
@@ -98,7 +100,9 @@ the following public API:
support directive classes otherwise).
For example, the (already existing) :dir:`literalinclude` directive would be
- added like this::
+ added like this:
+
+ .. code-block:: python
from docutils.parsers.rst import directives
add_directive('literalinclude', literalinclude_directive,
diff --git a/doc/themes/fullsize/nature.png b/doc/themes/fullsize/nature.png
new file mode 100644
index 00000000..d42957e3
--- /dev/null
+++ b/doc/themes/fullsize/nature.png
Binary files differ
diff --git a/doc/themes/nature.png b/doc/themes/nature.png
new file mode 100644
index 00000000..053970d8
--- /dev/null
+++ b/doc/themes/nature.png
Binary files differ
diff --git a/doc/theming.rst b/doc/theming.rst
index c2566ac3..4771dbec 100644
--- a/doc/theming.rst
+++ b/doc/theming.rst
@@ -65,9 +65,9 @@ Builtin themes
| | |
| *scrolls* | *agogo* |
+--------------------+--------------------+
-| |traditional| | |
+| |traditional| | |nature| |
| | |
-| *traditional* | |
+| *traditional* | *nature* |
+--------------------+--------------------+
.. |default| image:: themes/default.png
@@ -75,6 +75,7 @@ Builtin themes
.. |scrolls| image:: themes/scrolls.png
.. |agogo| image:: themes/agogo.png
.. |traditional| image:: themes/traditional.png
+.. |nature| image:: themes/nature.png
Sphinx comes with a selection of themes to choose from.
@@ -157,6 +158,9 @@ These themes are:
- **headerlinkcolor** (CSS color): Color for the backreference link in
headings.
+* **nature** -- A greenish theme. There are currently no options beyond
+ *nosidebar*.
+
* **traditional** -- A theme resembling the old Python documentation. There are
currently no options beyond *nosidebar*.