upstream/ipython Files · docs/sphinxext/configtraits.py

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

docs: add more pointers to configuration of embedded IPython The "Running IPython from Python" section of the docs under "Configuring IPython" gives a nice example of how to set IPython configuration options when embedding IPython. Add more pointer to this part of the documentation by linking to it from the docstrings of IPython.{embed_kernel, start_ipython, start_kernel} and IPython.terminal.embed.embed. While at it, consistenly refer to the config argument as "a traitlets :class:`Config` object". Finally, also mention that options can be set with a 'Config' object in the small paragraph under "IPython options".

Lumir Balhar - - Load All Authors

File last commit:

r25608:70b7090a


                r28185:9e43aba8

Download file

             configtraits.py
        
                    16 lines
            
             | 414 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / sphinxext / configtraits.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Directives and roles for documenting traitlets config options.

      ::

          .. configtrait:: Application.log_datefmt

              Description goes here.

          Cross reference like this: :configtrait:`Application.log_datefmt`.

      """

      def setup(app):

          app.add_object_type('configtrait', 'configtrait', objname='Config option')

          metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}

          return metadata

	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

				"""Directives and roles for documenting traitlets config options.

				::

				.. configtrait:: Application.log_datefmt

				Description goes here.

				Cross reference like this: :configtrait:`Application.log_datefmt`.
				"""


				def setup(app):
				app.add_object_type('configtrait', 'configtrait', objname='Config option')
				metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
				return metadata