upstream/ipython Files · IPython/utils/localinterfaces.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Srinivas Reddy Thatiparthy - - Load All Authors

File last commit:

r23033:5dd70876


                r28197:ad452c1d

Download file

             localinterfaces.py
        
                    5 lines
            
             | 169 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / localinterfaces.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Min RK
    
shim utils.localinterfaces

              r21132
            
      from warnings import warn

        Srinivas Reddy Thatiparthy
    
Add stacklevel=2  to warn function

              r23033
            
      warn("IPython.utils.localinterfaces has moved to jupyter_client.localinterfaces", stacklevel=2)

        Min RK
    
shim utils.localinterfaces

              r21132
            
      from jupyter_client.localinterfaces import *

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Min RK shim utils.localinterfaces	r21132	from warnings import warn

Srinivas Reddy Thatiparthy Add stacklevel=2 to warn function	r23033	warn("IPython.utils.localinterfaces has moved to jupyter_client.localinterfaces", stacklevel=2)
Min RK shim utils.localinterfaces	r21132
		from jupyter_client.localinterfaces import *