upstream/ipython Files · docs/autogen_config.py

safe_execfile_ipy optionally raises exception in user code

Thomas Kluyver - - Load All Authors

File last commit:

r21400:916e7031


                r21409:ba8af4d6

Download file

             autogen_config.py
        
                    29 lines
            
             | 1008 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / autogen_config.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Yaroslav Halchenko
    
ENH: list generated config files in generated, and rm them upon clean

              r16197
            
      #!/usr/bin/env python

        Thomas Kluyver
    
Generate docs for config options.

              r13459
            
      from IPython.terminal.ipapp import TerminalIPythonApp

        Thomas Kluyver
    
Use new traitlets API to generate config docs...

              r21400
            
      from ipykernel.kernelapp import IPKernelApp

        Thomas Kluyver
    
Generate docs for config options.

              r13459
            
        Thomas Kluyver
    
Use new traitlets API to generate config docs...

              r21400
            
      def write_doc(name, title, app, preamble=None):

        Yaroslav Halchenko
    
ENH: list generated config files in generated, and rm them upon clean

              r16197
            
          filename = '%s.rst' % name

          with open('source/config/options/%s' % filename, 'w') as f:

        Thomas Kluyver
    
Generate docs for config options.

              r13459
            
              f.write(title + '\n')

              f.write(('=' * len(title)) + '\n')

              f.write('\n')

              if preamble is not None:

                  f.write(preamble + '\n\n')

        Thomas Kluyver
    
Use new traitlets API to generate config docs...

              r21400
            
              f.write(app.document_config_options())

        Yaroslav Halchenko
    
ENH: list generated config files in generated, and rm them upon clean

              r16197
            
          with open('source/config/options/generated', 'a') as f:

              f.write(filename + '\n')

        Thomas Kluyver
    
Generate docs for config options.

              r13459
            
      if __name__ == '__main__':

        Yaroslav Halchenko
    
ENH: list generated config files in generated, and rm them upon clean

              r16197
            
          # create empty file

          with open('source/config/options/generated', 'w'):

              pass

        Thomas Kluyver
    
Use new traitlets API to generate config docs...

              r21400
            
          write_doc('terminal', 'Terminal IPython options', TerminalIPythonApp())

          write_doc('kernel', 'IPython kernel options', IPKernelApp(),

              preamble=("These options can be used in :file:`ipython_kernel_config.py`. "

                        "The kernel also respects any options in `ipython_config.py`"),

        MinRK
    
remove references to kernel config in parent config files...

              r18030
            
          )

        Thomas Kluyver
    
Generate docs for config options.

              r13459

	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

Yaroslav Halchenko ENH: list generated config files in generated, and rm them upon clean	r16197	#!/usr/bin/env python

Thomas Kluyver Generate docs for config options.	r13459	from IPython.terminal.ipapp import TerminalIPythonApp
Thomas Kluyver Use new traitlets API to generate config docs...	r21400	from ipykernel.kernelapp import IPKernelApp
Thomas Kluyver Generate docs for config options.	r13459
Thomas Kluyver Use new traitlets API to generate config docs...	r21400	def write_doc(name, title, app, preamble=None):
Yaroslav Halchenko ENH: list generated config files in generated, and rm them upon clean	r16197	filename = '%s.rst' % name
		with open('source/config/options/%s' % filename, 'w') as f:
Thomas Kluyver Generate docs for config options.	r13459	f.write(title + '\n')
		f.write(('=' * len(title)) + '\n')
		f.write('\n')
		if preamble is not None:
		f.write(preamble + '\n\n')
Thomas Kluyver Use new traitlets API to generate config docs...	r21400	f.write(app.document_config_options())
Yaroslav Halchenko ENH: list generated config files in generated, and rm them upon clean	r16197	with open('source/config/options/generated', 'a') as f:
		f.write(filename + '\n')

Thomas Kluyver Generate docs for config options.	r13459
		if __name__ == '__main__':
Yaroslav Halchenko ENH: list generated config files in generated, and rm them upon clean	r16197	# create empty file
		with open('source/config/options/generated', 'w'):
		pass

Thomas Kluyver Use new traitlets API to generate config docs...	r21400	write_doc('terminal', 'Terminal IPython options', TerminalIPythonApp())
		write_doc('kernel', 'IPython kernel options', IPKernelApp(),
		preamble=("These options can be used in :file:`ipython_kernel_config.py`. "
		"The kernel also respects any options in `ipython_config.py`"),
MinRK remove references to kernel config in parent config files...	r18030	)
Thomas Kluyver Generate docs for config options.	r13459