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

Merge pull request #1700 from ericholscher/toctree-name

Browse Source 
Add initial ability to name a TOC Tree
This commit is contained in:
Takayuki SHIMIZUKAWA 2015-03-08 15:04:35 +09:00
commit c5e0910958
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
sphinx/directives/other.py
View File

@ -40,6 +40,7 @@ class TocTree(Directive):
final_argument_whitespace = False final_argument_whitespace = False
option_spec = { option_spec = {
'maxdepth': int, 'maxdepth': int,
'name': str,
'glob': directives.flag, 'glob': directives.flag,
'hidden': directives.flag, 'hidden': directives.flag,
'includehidden': directives.flag, 'includehidden': directives.flag,
@ -51,6 +52,7 @@ class TocTree(Directive):
env = self.state.document.settings.env env = self.state.document.settings.env
suffixes = env.config.source_suffix suffixes = env.config.source_suffix
glob = 'glob' in self.options glob = 'glob' in self.options
name = self.options.get('name')
ret = [] ret = []
# (title, ref) pairs, where ref may be a document, or an external link, # (title, ref) pairs, where ref may be a document, or an external link,
@ -109,6 +111,7 @@ class TocTree(Directive):
# includefiles only entries that are documents # includefiles only entries that are documents
subnode['includefiles'] = includefiles subnode['includefiles'] = includefiles
subnode['maxdepth'] = self.options.get('maxdepth', -1) subnode['maxdepth'] = self.options.get('maxdepth', -1)
subnode['name'] = name
subnode['glob'] = glob subnode['glob'] = glob
subnode['hidden'] = 'hidden' in self.options subnode['hidden'] = 'hidden' in self.options
subnode['includehidden'] = 'includehidden' in self.options subnode['includehidden'] = 'includehidden' in self.options

8
sphinx/environment.py
View File

@ -1380,7 +1380,15 @@ class BuildEnvironment:
separate=False, subtree=False): separate=False, subtree=False):
"""Return TOC entries for a toctree node.""" """Return TOC entries for a toctree node."""
refs = [(e[0], e[1]) for e in toctreenode['entries']] refs = [(e[0], e[1]) for e in toctreenode['entries']]
name = toctreenode.attributes.get('name')
entries = [] entries = []
if name:
entries.extend(
nodes.reference('', '', internal=False,
refuri='', anchorname='',
*[nodes.Text(name)])
)
for (title, ref) in refs: for (title, ref) in refs:
try: try:
refdoc = None refdoc = None