diff options
| author | Georg Brandl <georg@python.org> | 2009-01-26 22:42:00 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-01-26 22:42:00 +0100 |
| commit | cfbfe8dc82f25bddfb6ec8a27fa78fd01c56c70a (patch) | |
| tree | a79ad31cdbfa03e3b03bb70232c71b61876df1d1 /doc/config.rst | |
| parent | 1eec03fe7471cbf63d6b5e0595b26f0c05ebb744 (diff) | |
| parent | f5e2ccd6c0728861b0eaf9794b021ca498f51896 (diff) | |
| download | sphinx-cfbfe8dc82f25bddfb6ec8a27fa78fd01c56c70a.tar.gz | |
merge with 0.5
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/doc/config.rst b/doc/config.rst index e6af9aae..dd25cf22 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -22,8 +22,8 @@ Important points to note: * The term "fully-qualified name" refers to a string that names an importable Python object inside a module; for example, the FQN - ``"sphinx.builder.Builder"`` means the ``Builder`` class in the - ``sphinx.builder`` module. + ``"sphinx.builders.Builder"`` means the ``Builder`` class in the + ``sphinx.builders`` module. * Remember that document names use ``/`` as the path separator and don't contain the file name extension. @@ -205,6 +205,7 @@ Project information * ``en`` -- English * ``es`` -- Spanish * ``fr`` -- French + * ``it`` -- Italian * ``nl`` -- Dutch * ``pl`` -- Polish * ``pt_BR`` -- Brazilian Portuguese @@ -332,6 +333,15 @@ that use Sphinx' HTMLWriter class. If true, *SmartyPants* will be used to convert quotes and dashes to typographically correct entities. Default: ``True``. +.. confval:: html_add_permalinks + + If true, Sphinx will add "permalinks" for each heading and description + environment as paragraph signs that become visible when the mouse hovers over + them. Default: ``True``. + + .. versionadded:: 0.6 + Previously, this was always activated. + .. confval:: html_sidebars Custom sidebar templates, must be a dictionary that maps document names to @@ -399,6 +409,13 @@ that use Sphinx' HTMLWriter class. will only display the titles of matching documents, and no excerpt from the matching contents. +.. confval:: html_show_sourcelink + + If true (and :confval:`html_copy_source` is true as well), links to the + reST sources will be added to the sidebar. The default is ``True``. + + .. versionadded:: 0.6 + .. confval:: html_use_opensearch If nonempty, an `OpenSearch <http://opensearch.org>` description file will be @@ -415,10 +432,18 @@ that use Sphinx' HTMLWriter class. .. versionadded:: 0.4 +.. confval:: html_link_suffix + + Suffix for generated links to HTML files. The default is whatever + :confval:`html_file_suffix` is set to; it can be set differently (e.g. to + support different web server setups). + + .. versionadded:: 0.6 + .. confval:: html_translator_class A string with the fully-qualified name of a HTML Translator class, that is, a - subclass of Sphinx' :class:`~sphinx.htmlwriter.HTMLTranslator`, that is used + subclass of Sphinx' :class:`~sphinx.writers.html.HTMLTranslator`, that is used to translate document trees to HTML. Default is ``None`` (use the builtin translator). |
