-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document embed() under IPython
The narrative documentation refers to embed() as IPython.embed(), but this function is not documented under the IPython module in the API docs, it is under IPython.terminal.embed. This is because IPython is not listed in the __names_from_all__ list in autogen_api.py, so only functions defined directly in IPython/__init__.py are listed, and embed() is _imported_ there from IPython.terminal.embed. Add the documentation of embed directly under the IPython module by adding 'IPython' to the __names_from_all__ list. Note that we avoid excluding IPython.terminal.embed in the lists of patterns to skip since we still want to document the rest of the names in this module. Add an explicit __all__ list in IPython/__init__.py, listing the currently documented functions as well as embed(). Finally, tweak the embed() docstring to refer explicitely to terminal.embed.InteractiveShellEmbed so that these links keep working.
- Loading branch information
1 parent
1d7eee5
commit 82a6309
Showing
3 changed files
with
7 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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