upstream/ipython Files · docs/source/config/options/index.rst

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.

Philippe Blain - - Load All Authors

File last commit:

r28185:9e43aba8


                r28197:ad452c1d

Download file

             index.rst
        
                    12 lines
            
             | 271 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / source / config / options / index.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Thomas Kluyver
    
Generate docs for config options.

              r13459
            
      ===============

      IPython options

      ===============

        Thomas Kluyver
    
Refer to how to set config from options list

              r13503
            
      Any of the options listed here can be set in config files, at the

        Philippe Blain
    
docs: add more pointers to configuration of embedded IPython...

              r28185
            
      command line, from inside IPython, or using a traitlets :class:`Config` object.

      See :ref:`setting_config` for details.

        Thomas Kluyver
    
Refer to how to set config from options list

              r13503
            
        Thomas Kluyver
    
Revert part of gh-9567

              r22615
            
      .. toctree::

         terminal

         kernel

	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

Thomas Kluyver Generate docs for config options.	r13459	===============
		IPython options
		===============

Thomas Kluyver Refer to how to set config from options list	r13503	Any of the options listed here can be set in config files, at the
Philippe Blain docs: add more pointers to configuration of embedded IPython...	r28185	command line, from inside IPython, or using a traitlets :class:`Config` object.
		See :ref:`setting_config` for details.
Thomas Kluyver Refer to how to set config from options list	r13503
Thomas Kluyver Revert part of gh-9567	r22615	.. toctree::

		terminal
		kernel