upstream/ipython Files · IPython/__main__.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.

azjps - - Load All Authors

File last commit:

r27960:3455b573


                r28197:ad452c1d

Download file

             __main__.py
        
                    15 lines
            
             | 488 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / __main__.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # PYTHON_ARGCOMPLETE_OK

      # encoding: utf-8

      """Terminal-based IPython entry point.

      """

      #-----------------------------------------------------------------------------

      #  Copyright (c) 2012, IPython Development Team.

      #

      #  Distributed under the terms of the Modified BSD License.

      #

      #  The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      from IPython import start_ipython

      start_ipython()

	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

				# PYTHON_ARGCOMPLETE_OK
				# encoding: utf-8
				"""Terminal-based IPython entry point.
				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2012, IPython Development Team.
				#
				# Distributed under the terms of the Modified BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------

				from IPython import start_ipython

				start_ipython()