upstream/ipython Files · docs/autogen_config.py

Remove outdated info from README...

Remove outdated info from README We no longer use submodules, and a development install is now no different from how you'd do an editable install of any Python package, so there's no need for us to be documenting it explicitly.

Thomas Kluyver - - Load All Authors

File last commit:

r21400:916e7031


                r21499:bec8d3dc

Download file

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

      #!/usr/bin/env python

      from IPython.terminal.ipapp import TerminalIPythonApp

      from ipykernel.kernelapp import IPKernelApp

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

          filename = '%s.rst' % name

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

              f.write(title + '\n')

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

              f.write('\n')

              if preamble is not None:

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

              f.write(app.document_config_options())

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

              f.write(filename + '\n')

      if __name__ == '__main__':

          # create empty file

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

              pass

          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`"),

          )

	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

				#!/usr/bin/env python

				from IPython.terminal.ipapp import TerminalIPythonApp
				from ipykernel.kernelapp import IPKernelApp

				def write_doc(name, title, app, preamble=None):
				filename = '%s.rst' % name
				with open('source/config/options/%s' % filename, 'w') as f:
				f.write(title + '\n')
				f.write(('=' * len(title)) + '\n')
				f.write('\n')
				if preamble is not None:
				f.write(preamble + '\n\n')
				f.write(app.document_config_options())
				with open('source/config/options/generated', 'a') as f:
				f.write(filename + '\n')


				if __name__ == '__main__':
				# create empty file
				with open('source/config/options/generated', 'w'):
				pass

				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`"),
				)