Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Use newer toctree syntax.

This commit is contained in:
Georg Brandl 2010-06-12 09:45:01 +00:00
parent 3e83ff78c6
commit fd3eff68f5
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Doc/documenting/markup.rst
View File

@ -698,10 +698,10 @@ tables of contents. The ``toctree`` directive is the central element.
.. toctree::
:maxdepth: 2
intro.rst
strings.rst
datatypes.rst
numeric.rst
intro
strings
datatypes
numeric
(many more files listed here)
This accomplishes two things:
@ -709,8 +709,8 @@ tables of contents. The ``toctree`` directive is the central element.
* Tables of contents from all those files are inserted, with a maximum depth
of two, that means one nested heading. ``toctree`` directives in those
files are also taken into account.
* Sphinx knows that the relative order of the files ``intro.rst``,
``strings.rst`` and so forth, and it knows that they are children of the
* Sphinx knows that the relative order of the files ``intro``,
``strings`` and so forth, and it knows that they are children of the
shown file, the library index. From this information it generates "next
chapter", "previous chapter" and "parent chapter" links.