mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Allow to access mangers through env.{manager_name}
This commit is contained in:
parent
e5b3a7c951
commit
97870ebc0b
@ -212,6 +212,7 @@ class BuildEnvironment(object):
|
|||||||
for manager_class in [IndexEntries, Toctree]:
|
for manager_class in [IndexEntries, Toctree]:
|
||||||
manager = manager_class(self)
|
manager = manager_class(self)
|
||||||
self.managers[manager.name] = manager
|
self.managers[manager.name] = manager
|
||||||
|
setattr(self, manager.name, manager)
|
||||||
|
|
||||||
def set_warnfunc(self, func):
|
def set_warnfunc(self, func):
|
||||||
self._warnfunc = func
|
self._warnfunc = func
|
||||||
@ -593,8 +594,8 @@ class BuildEnvironment(object):
|
|||||||
self._warnfunc(*warning, **kwargs)
|
self._warnfunc(*warning, **kwargs)
|
||||||
|
|
||||||
def check_dependents(self, already):
|
def check_dependents(self, already):
|
||||||
toctree = self.managers['toctree']
|
to_rewrite = (self.toctree.assign_section_numbers() +
|
||||||
to_rewrite = toctree.assign_section_numbers() + toctree.assign_figure_numbers()
|
self.toctree.assign_figure_numbers())
|
||||||
for docname in set(to_rewrite):
|
for docname in set(to_rewrite):
|
||||||
if docname not in already:
|
if docname not in already:
|
||||||
yield docname
|
yield docname
|
||||||
@ -938,15 +939,15 @@ class BuildEnvironment(object):
|
|||||||
"""Note a TOC tree directive in a document and gather information about
|
"""Note a TOC tree directive in a document and gather information about
|
||||||
file relations from it.
|
file relations from it.
|
||||||
"""
|
"""
|
||||||
self.managers['toctree'].note_toctree(docname, toctreenode)
|
self.toctree.note_toctree(docname, toctreenode)
|
||||||
|
|
||||||
def get_toc_for(self, docname, builder):
|
def get_toc_for(self, docname, builder):
|
||||||
"""Return a TOC nodetree -- for use on the same page only!"""
|
"""Return a TOC nodetree -- for use on the same page only!"""
|
||||||
return self.managers['toctree'].get_toc_for(docname, builder)
|
return self.toctree.get_toc_for(docname, builder)
|
||||||
|
|
||||||
def get_toctree_for(self, docname, builder, collapse, **kwds):
|
def get_toctree_for(self, docname, builder, collapse, **kwds):
|
||||||
"""Return the global TOC nodetree."""
|
"""Return the global TOC nodetree."""
|
||||||
return self.managers['toctree'].get_toctree_for(docname, builder, collapse, **kwds)
|
return self.toctree.get_toctree_for(docname, builder, collapse, **kwds)
|
||||||
|
|
||||||
def get_domain(self, domainname):
|
def get_domain(self, domainname):
|
||||||
"""Return the domain instance with the specified name.
|
"""Return the domain instance with the specified name.
|
||||||
@ -1006,9 +1007,9 @@ class BuildEnvironment(object):
|
|||||||
If *collapse* is True, all branches not containing docname will
|
If *collapse* is True, all branches not containing docname will
|
||||||
be collapsed.
|
be collapsed.
|
||||||
"""
|
"""
|
||||||
return self.managers['toctree'].resolve_toctree(docname, builder, toctree, prune,
|
return self.toctree.resolve_toctree(docname, builder, toctree, prune,
|
||||||
maxdepth, titles_only, collapse,
|
maxdepth, titles_only, collapse,
|
||||||
includehidden)
|
includehidden)
|
||||||
|
|
||||||
def resolve_references(self, doctree, fromdocname, builder):
|
def resolve_references(self, doctree, fromdocname, builder):
|
||||||
for node in doctree.traverse(addnodes.pending_xref):
|
for node in doctree.traverse(addnodes.pending_xref):
|
||||||
@ -1138,8 +1139,7 @@ class BuildEnvironment(object):
|
|||||||
|
|
||||||
def create_index(self, builder, group_entries=True,
|
def create_index(self, builder, group_entries=True,
|
||||||
_fixre=re.compile(r'(.*) ([(][^()]*[)])')):
|
_fixre=re.compile(r'(.*) ([(][^()]*[)])')):
|
||||||
entries = self.managers['indexentries']
|
return self.indices.create_index(builder, group_entries=group_entries, _fixre=_fixre)
|
||||||
return entries.create_index(builder, group_entries=group_entries, _fixre=_fixre)
|
|
||||||
|
|
||||||
def collect_relations(self):
|
def collect_relations(self):
|
||||||
traversed = set()
|
traversed = set()
|
||||||
|
@ -23,7 +23,7 @@ from sphinx.environment.managers import EnvironmentManager
|
|||||||
|
|
||||||
|
|
||||||
class IndexEntries(EnvironmentManager):
|
class IndexEntries(EnvironmentManager):
|
||||||
name = 'indexentries'
|
name = 'indices'
|
||||||
|
|
||||||
def __init__(self, env):
|
def __init__(self, env):
|
||||||
super(IndexEntries, self).__init__(env)
|
super(IndexEntries, self).__init__(env)
|
||||||
|
Loading…
Reference in New Issue
Block a user