Fix docs build: resolve InteractiveShell forward reference#1506
Closed
erikgaas wants to merge 7 commits intoipython:mainfrom
Closed
Fix docs build: resolve InteractiveShell forward reference#1506erikgaas wants to merge 7 commits intoipython:mainfrom
InteractiveShell forward reference#1506erikgaas wants to merge 7 commits intoipython:mainfrom
Conversation
…agics sphinx_autodoc_typehints cannot resolve inherited type annotations from parent classes in a different module. KernelMagics inherits shell: InteractiveShell from IPython's Magics, but sphinx evaluates it in the parent module's namespace. Re-declare the annotation in KernelMagics so sphinx resolves it in zmqshell.py where InteractiveShell is imported.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs build has been failing because
sphinx_autodoc_typehintscannot resolve the inheritedshell: InteractiveShellannotation onKernelMagics. The annotation comes from IPython'sMagicsbase class, but sphinx evaluates it in the parent module's namespace whereInteractiveShellisn't available.Fix
Re-declare the
shelltype annotation directly inKernelMagics, whereInteractiveShellis already imported.1 file changed, 1 insertion.