[Python-checkins] r64725 - in doctools/branches/0.4.x: doc/concepts.rst sphinx/texinputs/howto.cls sphinx/texinputs/manual.cls
georg.brandl
python-checkins at python.org
Sat Jul 5 12:31:43 CEST 2008
Author: georg.brandl
Date: Sat Jul 5 12:31:43 2008
New Revision: 64725
Log:
Add note about :maxdepth: in toctrees and latex.
Modified:
doctools/branches/0.4.x/doc/concepts.rst
doctools/branches/0.4.x/sphinx/texinputs/howto.cls
doctools/branches/0.4.x/sphinx/texinputs/manual.cls
Modified: doctools/branches/0.4.x/doc/concepts.rst
==============================================================================
--- doctools/branches/0.4.x/doc/concepts.rst (original)
+++ doctools/branches/0.4.x/doc/concepts.rst Sat Jul 5 12:31:43 2008
@@ -33,7 +33,7 @@
individual TOCs (including "sub-TOC trees") of the documents given in the
directive body (whose path is relative to the document the directive occurs
in). A numeric ``maxdepth`` option may be given to indicate the depth of the
- tree; by default, all levels are included.
+ tree; by default, all levels are included. [#]_
Consider this example (taken from the Python docs' library reference index)::
@@ -132,6 +132,12 @@
.. 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}``.
+
.. [#] A note on available globbing syntax: you can use the standard shell
constructs ``*``, ``?``, ``[...]`` and ``[!...]`` with the feature that
these all don't match slashes. A double star ``**`` can be used to match
Modified: doctools/branches/0.4.x/sphinx/texinputs/howto.cls
==============================================================================
--- doctools/branches/0.4.x/sphinx/texinputs/howto.cls (original)
+++ doctools/branches/0.4.x/sphinx/texinputs/howto.cls Sat Jul 5 12:31:43 2008
@@ -14,7 +14,7 @@
% Set some sane defaults for section numbering depth and TOC depth. You can
-% reset these counter in your preamble.
+% reset these counters in your preamble.
%
\setcounter{secnumdepth}{2}
Modified: doctools/branches/0.4.x/sphinx/texinputs/manual.cls
==============================================================================
--- doctools/branches/0.4.x/sphinx/texinputs/manual.cls (original)
+++ doctools/branches/0.4.x/sphinx/texinputs/manual.cls Sat Jul 5 12:31:43 2008
@@ -14,7 +14,7 @@
% Set some sane defaults for section numbering depth and TOC depth. You can
-% reset these counter in your preamble.
+% reset these counters in your preamble.
%
\setcounter{secnumdepth}{2}
\setcounter{tocdepth}{1}
More information about the Python-checkins
mailing list