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

Nikita Kniazev - - Load All Authors

File last commit:

r27042:360df2b6


                r28197:ad452c1d

Download file

             __init__.py
        
                    20 lines
            
             | 784 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / testing / __init__.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Testing support (tools to test IPython itself).

      """

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

      #  Copyright (C) 2009-2011  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

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

      import os

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

      # Constants

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

      # We scale all timeouts via this factor, slow machines can increase it

      IPYTHON_TESTING_TIMEOUT_SCALE = float(os.getenv(

                                          'IPYTHON_TESTING_TIMEOUT_SCALE', 1))

	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

				"""Testing support (tools to test IPython itself).
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2009-2011 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------


				import os

				#-----------------------------------------------------------------------------
				# Constants
				#-----------------------------------------------------------------------------

				# We scale all timeouts via this factor, slow machines can increase it
				IPYTHON_TESTING_TIMEOUT_SCALE = float(os.getenv(
				'IPYTHON_TESTING_TIMEOUT_SCALE', 1))