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

Merged revisions 64725-64726,64730 via svnmerge from

Browse Source 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64725 | georg.brandl | 2008-07-05 12:31:43 +0200 (Sat, 05 Jul 2008) | 2 lines

  Add note about :maxdepth: in toctrees and latex.
........
  r64726 | georg.brandl | 2008-07-05 12:55:07 +0200 (Sat, 05 Jul 2008) | 2 lines

  Add object names for e.g. :ivar:.
........
  r64730 | georg.brandl | 2008-07-05 16:34:35 +0200 (Sat, 05 Jul 2008) | 2 lines

  Fix another IE problem.
........
This commit is contained in:
Georg Brandl
2008-07-05 14:48:10 +00:00
parent de00fbb2da
commit 5a8779fac3
5 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/concepts.rst
View File

@@ -33,7 +33,7 @@ tables of contents. The ``toctree`` directive is the central element.
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 @@ 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}``.
.. [#] 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

3
sphinx/directives/desc.py
View File

@@ -151,8 +151,9 @@ def handle_doc_fields(node):
elif typ == 'type':
param_types[obj] = fbody.astext()
else:
fieldname = typ + ' ' + obj
nfield = nodes.field()
nfield += nodes.field_name(typ, typ)
nfield += nodes.field_name(fieldname, fieldname)
nfield += nodes.field_body()
nfield[1] += fbody.children
new_list += nfield

2
sphinx/static/searchtools.js
View File

@@ -393,7 +393,7 @@ var Search = {
}
displayNextItem();
});
},
}
}

2
sphinx/texinputs/howto.cls
View File

@@ -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}

2
sphinx/texinputs/manual.cls
View File

@@ -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}