diff options
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 75 |
1 files changed, 74 insertions, 1 deletions
diff --git a/doc/config.rst b/doc/config.rst index 5d188c61..6174d487 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,16 +377,19 @@ documentation on :ref:`intl` for details. * ``fi`` -- Finnish * ``fr`` -- French * ``hr`` -- Croatian + * ``hu`` -- Hungarian * ``it`` -- Italian * ``ja`` -- Japanese * ``ko`` -- Korean * ``lt`` -- Lithuanian * ``lv`` -- Latvian + * ``nb_NO`` -- Norwegian Bokmal * ``ne`` -- Nepali * ``nl`` -- Dutch * ``pl`` -- Polish * ``pt_BR`` -- Brazilian Portuguese * ``ru`` -- Russian + * ``sk`` -- Slovak * ``sl`` -- Slovenian * ``sv`` -- Swedish * ``tr`` -- Turkish @@ -757,6 +760,15 @@ that use Sphinx' HTMLWriter class. .. versionadded:: 1.1 +.. confval:: html_search_scorer + + The name of a javascript file (relative to the configuration directory) that + implements a search results scorer. If empty, the default will be used. + + .. XXX describe interface for scorer here + + .. versionadded:: 1.2 + .. confval:: htmlhelp_basename Output file base name for HTML help builder. Default is ``'pydoc'``. @@ -783,6 +795,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 @@ -844,6 +864,20 @@ the `Dublin Core metadata <http://dublincore.org/>`_. .. versionadded:: 1.1 +.. confval:: epub_guide + + Meta data for the guide element of :file:`content.opf`. This is a + sequence of tuples containing the *type*, the *uri* and the *title* of + the optional guide information. See the OPF documentation + at `<http://idpf.org/epub>`_ for details. If possible, default entries + for the *cover* and *toc* types are automatically inserted. However, + the types can be explicitely overwritten if the default entries are not + appropriate. Example:: + + epub_guide = (('cover', 'cover.html', u'Cover Page'),) + + The default value is ``()``. + .. confval:: epub_pre_files Additional files that should be inserted before the text generated by @@ -882,6 +916,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 +1342,24 @@ 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 + + +Options for the XML builder +--------------------------- + +.. confval:: xml_pretty + + If True, pretty-print the XML. Default is ``True``. + + .. versionadded:: 1.2 + .. rubric:: Footnotes |