IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update about toctree directive

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-03-21 16:37:34 +09:00
parent 593dcaf40c
commit eccb9abe4a
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/usage/restructuredtext/directives.rst
View File

@ -48,6 +48,11 @@ tables of contents. The ``toctree`` directive is the central element.
to the source directory. A numeric ``maxdepth`` option may be given to to the source directory. A numeric ``maxdepth`` option may be given to
indicate the depth of the tree; by default, all levels are included. [#]_ indicate the depth of the tree; by default, all levels are included. [#]_
The representation of "TOC tree" is changed in each output format. The
builders that output multiple files (ex. HTML) treat it as a collection of
hyperlinks. On the other hand, the builders output a single file (ex. LaTeX,
man page, etc.) replace it with the content of the documents on the TOC tree.
Consider this example (taken from the Python docs' library reference index):: Consider this example (taken from the Python docs' library reference index)::
.. toctree:: .. toctree::