diff options
| author | georg.brandl <devnull@localhost> | 2008-05-24 18:03:56 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-05-24 18:03:56 +0000 |
| commit | ebc0bf3629e7868b8639a94c0b753912afc5739f (patch) | |
| tree | e0c622c76a168f22b7517c75ab88d258c24a3e5c /doc | |
| parent | 2b8b2b1004e1e374ab4698352c0e9dc9e1e04458 (diff) | |
| download | sphinx-ebc0bf3629e7868b8639a94c0b753912afc5739f.tar.gz | |
Add html_short_title and html_show_sphinx config values.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 15 | ||||
| -rw-r--r-- | doc/ext/appapi.rst | 7 |
2 files changed, 21 insertions, 1 deletions
diff --git a/doc/config.rst b/doc/config.rst index ed1b7b14..838a013e 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -182,6 +182,14 @@ that use Sphinx' HTMLWriter class. v{<revision>} documentation'`, where the placeholders are replaced by the config values of the same name. +.. confval:: html_short_title + + A shorter "title" for the HTML docs. This is used in for links in the header + and in the HTML Help docs. If not given, it defaults to the value of + :confval:`html_title`. + + .. versionadded:: 0.4 + .. confval:: html_style The style sheet to use for HTML pages. A file of that name must exist either @@ -293,6 +301,13 @@ that use Sphinx' HTMLWriter class. to translate document trees to HTML. Default is ``None`` (use the builtin translator). +.. confval:: html_show_sphinx + + If true, "Created using Sphinx" is shown in the HTML footer. Default is + ``True``. + + .. versionadded:: 0.4 + .. confval:: htmlhelp_basename Output file base name for HTML help builder. Default is ``'pydoc'``. diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index a0eeeeb7..616708ad 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -24,6 +24,11 @@ the following public API: in the setting only takes effect when a document is parsed -- this means that the whole environment must be rebuilt. + .. versionchanged:: 0.4 + If the *default* value is a callable, it will be called with the config + object as its argument in order to get the default value. This can be + used to implement config values whose default depends on other values. + .. method:: Sphinx.add_event(name) Register an event called *name*. @@ -43,7 +48,7 @@ the following public API: documentation. .. XXX once we target docutils 0.5, update this - + .. method:: Sphinx.add_role(name, role) Register a Docutils role. *name* must be the role name that occurs in the |
