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

Fix #7151: crashed when extension assigns a value to env.indexentries
This commit is contained in:
Takeshi KOMIYA 2020-02-16 21:19:45 +09:00 committed by GitHub
commit 9f237445bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 0 deletions

View File

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

View File

@ -755,6 +755,14 @@ class BuildEnvironment:
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