summaryrefslogtreecommitdiff
path: root/doc/markup
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2016-02-29 11:29:07 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2016-03-02 11:11:11 +0900
commit119b97180428d4db93ab8deb973a98f932bddbb9 (patch)
treec6ed90aba7ac1557ddccfb895bb5966f2e3c990e /doc/markup
parenta2efd1475a026b09918a276813164fca3880c97c (diff)
downloadsphinx-git-119b97180428d4db93ab8deb973a98f932bddbb9.tar.gz
update doc: LaTeX writer now refers maxdepth option (ref #2358)
Diffstat (limited to 'doc/markup')
-rw-r--r--doc/markup/toctree.rst7
1 files changed, 2 insertions, 5 deletions
diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst
index ff0af7535..e089115a0 100644
--- a/doc/markup/toctree.rst
+++ b/doc/markup/toctree.rst
@@ -223,11 +223,8 @@ The special document names (and pages generated for them) are:
.. rubric:: Footnotes
-.. [#] The ``maxdepth`` option does not apply to the LaTeX writer, where the
- whole table of contents will always be presented at the begin of the
- document, and its depth is controlled by the ``tocdepth`` counter, which
- you can reset in your :confval:`latex_preamble` config value using
- e.g. ``\setcounter{tocdepth}{2}``.
+.. [#] The LaTeX writer only refers the ``maxdepth`` option of first toctree
+ directive in the document.
.. [#] A note on available globbing syntax: you can use the standard shell
constructs ``*``, ``?``, ``[...]`` and ``[!...]`` with the feature that