upstream/ipython Files · docs/autogen_config.py

Add metadata to DisplayObject (#10614)...

Add metadata to DisplayObject (#10614) The aim of this PR is to get it so that DisplayObject has a metadata API that can be inherited by it's subclasses. One of the challenges in designing this is to not destroy those subclasses that had already defined their own metadata API (such as Image). This also adds a way for SVG objects to surface metadata when returned or displayed.

Thomas Kluyver - - Load All Authors

File last commit:

r22615:3d83950a


                r23746:4883c32a

Download file

             autogen_config.py
        
                    33 lines
            
             | 1.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / autogen_config.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #!/usr/bin/env python

      from os.path import join, dirname, abspath

      from IPython.terminal.ipapp import TerminalIPythonApp

      from ipykernel.kernelapp import IPKernelApp

      here = abspath(dirname(__file__))

      options = join(here, 'source', 'config', 'options')

      generated = join(options, 'config-generated.txt')

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

          filename = join(options, name+'.rst')

          with open(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())

      if __name__ == '__main__':

          # Touch this file for the make target

          with open(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 os.path import join, dirname, abspath

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

				here = abspath(dirname(__file__))
				options = join(here, 'source', 'config', 'options')
				generated = join(options, 'config-generated.txt')


				def write_doc(name, title, app, preamble=None):
				filename = join(options, name+'.rst')
				with open(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())


				if __name__ == '__main__':
				# Touch this file for the make target
				with open(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`"),
				)