mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add EnvironmentManager.get_updated_docs() to weaken the coupling env modules
This commit is contained in:
parent
b2c76f44b6
commit
105951cdb2
@ -647,8 +647,9 @@ class BuildEnvironment(object):
|
|||||||
|
|
||||||
def check_dependents(self, already):
|
def check_dependents(self, already):
|
||||||
# type: (Set[unicode]) -> Iterator[unicode]
|
# type: (Set[unicode]) -> Iterator[unicode]
|
||||||
to_rewrite = (self.toctree.assign_section_numbers() + # type: ignore
|
to_rewrite = []
|
||||||
self.toctree.assign_figure_numbers()) # type: ignore
|
for manager in itervalues(self.managers):
|
||||||
|
to_rewrite.extend(manager.get_updated_docs())
|
||||||
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
|
||||||
|
@ -48,3 +48,7 @@ class EnvironmentManager(object):
|
|||||||
def process_doc(self, docname, doctree):
|
def process_doc(self, docname, doctree):
|
||||||
# type: (unicode, nodes.Node) -> None
|
# type: (unicode, nodes.Node) -> None
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
|
def get_updated_docs(self):
|
||||||
|
# type: () -> List[unicode]
|
||||||
|
raise NotImplementedError
|
||||||
|
@ -65,6 +65,10 @@ class IndexEntries(EnvironmentManager):
|
|||||||
else:
|
else:
|
||||||
entries.append(entry + (None,))
|
entries.append(entry + (None,))
|
||||||
|
|
||||||
|
def get_updated_docs(self):
|
||||||
|
# type: () -> List[unicode]
|
||||||
|
return []
|
||||||
|
|
||||||
def create_index(self, builder, group_entries=True,
|
def create_index(self, builder, group_entries=True,
|
||||||
_fixre=re.compile(r'(.*) ([(][^()]*[)])')):
|
_fixre=re.compile(r'(.*) ([(][^()]*[)])')):
|
||||||
# type: (Builder, bool, Pattern) -> List[Tuple[unicode, List[Tuple[unicode, List[unicode]]]]] # NOQA
|
# type: (Builder, bool, Pattern) -> List[Tuple[unicode, List[Tuple[unicode, List[unicode]]]]] # NOQA
|
||||||
|
@ -144,6 +144,10 @@ class Toctree(EnvironmentManager):
|
|||||||
self.tocs[docname] = nodes.bullet_list('')
|
self.tocs[docname] = nodes.bullet_list('')
|
||||||
self.toc_num_entries[docname] = numentries[0]
|
self.toc_num_entries[docname] = numentries[0]
|
||||||
|
|
||||||
|
def get_updated_docs(self):
|
||||||
|
# type: () -> List[unicode]
|
||||||
|
return self.assign_section_numbers() + self.assign_figure_numbers()
|
||||||
|
|
||||||
def note_toctree(self, docname, toctreenode):
|
def note_toctree(self, docname, toctreenode):
|
||||||
# type: (unicode, addnodes.toctree) -> None
|
# type: (unicode, addnodes.toctree) -> None
|
||||||
"""Note a TOC tree directive in a document and gather information about
|
"""Note a TOC tree directive in a document and gather information about
|
||||||
|
Loading…
Reference in New Issue
Block a user