diff options
| author | Georg Brandl <georg@python.org> | 2009-01-26 22:44:38 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-01-26 22:44:38 +0100 |
| commit | 5e74fc0f9acb5b2076d43d886e83b23c5cb0a046 (patch) | |
| tree | 14f6bc260a2777e651ce7abb59c6ab5f76684dac /doc | |
| parent | bb71945aa4e0ab85be000858a05616f72a4ed2a3 (diff) | |
| parent | cfbfe8dc82f25bddfb6ec8a27fa78fd01c56c70a (diff) | |
| download | sphinx-5e74fc0f9acb5b2076d43d886e83b23c5cb0a046.tar.gz | |
merge with trunk
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/concepts.rst | 5 | ||||
| -rw-r--r-- | doc/ext/appapi.rst | 7 | ||||
| -rw-r--r-- | doc/templating.rst | 23 |
3 files changed, 32 insertions, 3 deletions
diff --git a/doc/concepts.rst b/doc/concepts.rst index afb9503b..f2dcbd70 100644 --- a/doc/concepts.rst +++ b/doc/concepts.rst @@ -71,6 +71,9 @@ tables of contents. The ``toctree`` directive is the central element. The second line above will link to the ``strings`` document, but will use the title "All about strings" instead of the title of the ``strings`` document. + You can also add external links, by giving an HTTP URL instead of a document + name. + You can use "globbing" in toctree directives, by giving the ``glob`` flag option. All entries are then matched against the list of available documents, and matches are inserted into the list alphabetically. Example:: @@ -113,7 +116,7 @@ tables of contents. The ``toctree`` directive is the central element. Added "globbing" option. .. versionchanged:: 0.6 - Added "hidden" option. + Added "hidden" option and external links. Special names diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 84978da3..218c561b 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -86,6 +86,13 @@ the following public API: source, *role* the role function (see the `Docutils documentation <http://docutils.sourceforge.net/docs/howto/rst-roles.html>`_ on details). +.. method:: Sphinx.add_generic_role(name, nodeclass) + + Register a Docutils role that does nothing but wrap its contents in the + node given by *nodeclass*. + + .. versionadded:: 0.6 + .. method:: Sphinx.add_description_unit(directivename, rolename, indextemplate='', parse_node=None, ref_nodeclass=None) This method is a very convenient way to add a new type of information that diff --git a/doc/templating.rst b/doc/templating.rst index ff4bdd51..20c61ce0 100644 --- a/doc/templating.rst +++ b/doc/templating.rst @@ -221,8 +221,12 @@ in the future. .. data:: builder - The name of the builder (for builtin builders, ``html``, ``htmlhelp``, or - ``web``). + The name of the builder (e.g. ``html`` or ``htmlhelp``). + +.. data:: embedded + + True if the built HTML is supposed to be embedded in some application that + handles navigation, e.g. HTML Help or Qt Help. .. data:: next @@ -239,3 +243,18 @@ in the future. .. data:: prev Like :data:`next`, but for the previous page. + + +In documents that are created from source files (as opposed to +automatically-generated files like the module index, or documents that already +are in HTML form), these variables are also available: + +.. data:: toc + + The local table of contents for the current page, rendered as HTML bullet + lists. + +.. data:: toctree + + The global TOC tree containing the current page, rendered as HTML bullet + lists. |
