mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-09-03 20:52:55 -05:00
merge with trunk
This commit is contained in:
+4
-1
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
+21
-2
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user