-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve API documentation around configuration of embedded IPython #13989
Changes from all commits
2c9a826
af07fa3
af5f115
92c9881
9e43aba
97d929e
1d7eee5
853291b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -26,7 +26,7 @@ the following tools are needed to build the documentation: | |||||
In a conda environment, or a Python 3 ``venv``, you should be able to run:: | ||||||
|
||||||
cd ipython | ||||||
pip install .[doc] -U | ||||||
pip install -U -r docs/requirements.txt | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this file is here just for readthedocs, user should likely not use it.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As I note in af5f115, if one follows the instructions in |
||||||
|
||||||
|
||||||
Build Commands | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That should be unnecessary, and it seem to work as is with a cross ref, but I have no objections.
Dit it not work for you ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It did not work for me under
IPython
, only underIPython.terminal.embed
(after 853291b, which tweaks the API docs so thatembed()
appears under theIPython
module in addition to underIPython.terminal.embed
).