summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2012-03-10 21:38:29 +0100
committerGeorg Brandl <georg@python.org>2012-03-10 21:38:29 +0100
commitd6e2f000e1e41dd4b38d598a719d38fa6cc5603f (patch)
treec664a544259a7df56f22a985fb28577e3a34b86b /doc
parente1c220cae563aeb1b2520e4325384f0a95657873 (diff)
parentba36624ce9848cac923d5073157147ccc7caadb7 (diff)
downloadsphinx-d6e2f000e1e41dd4b38d598a719d38fa6cc5603f.tar.gz
merge with stable
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py4
-rw-r--r--doc/config.rst41
-rw-r--r--doc/domains.rst2
-rw-r--r--doc/rest.rst16
-rw-r--r--doc/theming.rst12
5 files changed, 60 insertions, 15 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 1b8ba3e4..6b547edd 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -36,7 +36,9 @@ epub_identifier = epub_publisher
epub_pre_files = [('index.html', 'Welcome')]
epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
'_static/jquery.js', '_static/searchtools.js', '_static/underscore.js',
- '_static/basic.css', 'search.html']
+ '_static/basic.css', 'search.html', '_static/websupport.js']
+epub_fix_images = False
+epub_max_image_width = 0
latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation',
'Georg Brandl', 'manual', 1)]
diff --git a/doc/config.rst b/doc/config.rst
index 5d188c61..a8d5c07f 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -277,7 +277,7 @@ Project information
the format given in :confval:`today_fmt`.
The default is no :confval:`today` and a :confval:`today_fmt` of ``'%B %d,
- %Y'`` (or, if translation is enabled with :confval:`language`, am equivalent
+ %Y'`` (or, if translation is enabled with :confval:`language`, an equivalent
%format for the selected locale).
.. confval:: highlight_language
@@ -377,6 +377,7 @@ documentation on :ref:`intl` for details.
* ``fi`` -- Finnish
* ``fr`` -- French
* ``hr`` -- Croatian
+ * ``hu`` -- Hungarian
* ``it`` -- Italian
* ``ja`` -- Japanese
* ``ko`` -- Korean
@@ -387,6 +388,7 @@ documentation on :ref:`intl` for details.
* ``pl`` -- Polish
* ``pt_BR`` -- Brazilian Portuguese
* ``ru`` -- Russian
+ * ``sk`` -- Slovak
* ``sl`` -- Slovenian
* ``sv`` -- Swedish
* ``tr`` -- Turkish
@@ -783,6 +785,14 @@ 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>`.
+
+ .. versionadded:: 1.2
+
.. confval:: epub_title
The title of the document. It defaults to the :confval:`html_title` option
@@ -882,6 +892,27 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
depth in one list. The default value is ``True``.
+.. confval:: epub_fix_images
+
+ This flag determines if sphinx should try to fix image formats that are not
+ supported by some epub readers. At the moment palette images with a small
+ color table are upgraded. You need the Python Image Library (PIL) installed
+ to use this option. The default value is ``False`` because the automatic
+ conversion may lose information.
+
+ .. versionadded:: 1.2
+
+.. confval:: epub_max_image_width
+
+ This option specifies the maximum width of images. If it is set to a value
+ greater than zero, images with a width larger than the given value are
+ scaled accordingly. If it is zero, no scaling is performed. The default
+ value is ``0``. You need the Python Image Library (PIL) installed to use
+ this option.
+
+ .. versionadded:: 1.2
+
+
.. _latex-options:
Options for LaTeX output
@@ -1287,6 +1318,14 @@ Options for the linkcheck builder
.. versionadded:: 1.1
+.. confval:: linkcheck_anchors
+
+ True or false, whether to check the validity of ``#anchor``\ s in links.
+ Since this requires downloading the whole document, it's considerably slower
+ when enabled. Default is ``True``.
+
+ .. versionadded:: 1.2
+
.. rubric:: Footnotes
diff --git a/doc/domains.rst b/doc/domains.rst
index 9894caab..3d52db3f 100644
--- a/doc/domains.rst
+++ b/doc/domains.rst
@@ -812,7 +812,7 @@ More domains
------------
The sphinx-contrib_ repository contains more domains available as extensions;
-currently a Ruby and an Erlang domain.
+currently Ada, Erlang, HTTP, PHP, and Ruby domains.
.. _sphinx-contrib: https://bitbucket.org/birkenfeld/sphinx-contrib/
diff --git a/doc/rest.rst b/doc/rest.rst
index db832ed8..ccf51c66 100644
--- a/doc/rest.rst
+++ b/doc/rest.rst
@@ -265,8 +265,9 @@ Docutils supports the following directives:
* Admonitions: :dudir:`attention`, :dudir:`caution`, :dudir:`danger`,
:dudir:`error`, :dudir:`hint`, :dudir:`important`, :dudir:`note`,
- :dudir:`tip`, :dudir:`warning` and the generic :dudir:`admonition`.
- (Most themes style only "note" and "warning" specially.)
+ :dudir:`tip`, :dudir:`warning` and the generic
+ :dudir:`admonition <admonitions>`. (Most themes style only "note" and
+ "warning" specially.)
* Images:
@@ -285,7 +286,7 @@ Docutils supports the following directives:
- :dudir:`epigraph` (a block quote with optional attribution line)
- :dudir:`highlights`, :dudir:`pull-quote` (block quotes with their own
class attribute)
- - :dudir:`compound` (a compound paragraph)
+ - :dudir:`compound <compound-paragraph>` (a compound paragraph)
* Special tables:
@@ -295,7 +296,7 @@ Docutils supports the following directives:
* Special directives:
- - :dudir:`raw` (include raw target-format markup)
+ - :dudir:`raw <raw-data-pass-through>` (include raw target-format markup)
- :dudir:`include` (include reStructuredText from another file)
-- in Sphinx, when given an absolute include file path, this directive takes
it as relative to the source directory
@@ -304,7 +305,7 @@ Docutils supports the following directives:
* HTML specifics:
- :dudir:`meta` (generation of HTML ``<meta>`` tags)
- - :dudir:`title` (override document title)
+ - :dudir:`title <metadata-document-title>` (override document title)
* Influencing markup:
@@ -472,9 +473,8 @@ There are some problems one commonly runs into while authoring reST documents:
* **Separation of inline markup:** As said above, inline markup spans must be
separated from the surrounding text by non-word characters, you have to use a
- backslash-escaped space to get around that. See `the reference
- <http://docutils.sf.net/docs/ref/rst/restructuredtext.html#inline-markup>`_
- for the details.
+ backslash-escaped space to get around that. See
+ :duref:`the reference <substitution-definitions>` for the details.
* **No nested inline markup:** Something like ``*see :func:`foo`*`` is not
possible.
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
---------------