Merge pull request #7158 from tk0miya/7151_env.indexentries_setter

Fix #7151: crashed when extension assigns a value to env.indexentries
sphinx-doc · Feb 16, 2020 · 9f23744 · 9f23744
2 parents 301a7e7 + a71c682
commit 9f23744
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -20,6 +20,7 @@ Bugs fixed
   as a value
 * #7156: autodoc: separator for keyword only arguments is not shown
 * #7146: autodoc: IndexError is raised on suppressed type_comment found
+* #7151: crashed when extension assigns a value to ``env.indexentries``
 
 Testing
 --------

diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py
@@ -755,6 +755,14 @@ def indexentries(self) -> Dict[str, List[Tuple[str, str, str, str, str]]]:
         domain = cast(IndexDomain, self.get_domain('index'))
         return domain.entries
 
+    @indexentries.setter
+    def indexentries(self, entries: Dict[str, List[Tuple[str, str, str, str, str]]]) -> None:
+        warnings.warn('env.indexentries() is deprecated. Please use IndexDomain instead.',
+                      RemovedInSphinx40Warning, stacklevel=2)
+        from sphinx.domains.index import IndexDomain
+        domain = cast(IndexDomain, self.get_domain('index'))
+        domain.data['entries'] = entries
+
 
 from sphinx.errors import NoUri  # NOQA