upstream/ipython Files · docs/autogen_api.py

Config system is finished!...

Config system is finished! * New load_subconfig(fname) function is available the namespace that config files are exec'd in. This can be used to load subconfigs. The implementation is a bit crazy, but Python is amazing and it works! See examples of its usage in IPython/config/profile. * Fully working example config files and profiles in IPython/config/default and IPython/config/profiles. Copy these to you .ipython dir and start playing around!

Brian Granger - - Load All Authors

File last commit:

r2197:71065c54


                r2258:f38cafce

Download file

             autogen_api.py
        
                    36 lines
            
             | 1.4 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / autogen_api.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #!/usr/bin/env python

      """Script to auto-generate our API docs.

      """

      # stdlib imports

      import os

      import sys

      # local imports

      sys.path.append(os.path.abspath('sphinxext'))

      from apigen import ApiDocWriter

      #*****************************************************************************

      if __name__ == '__main__':

          pjoin = os.path.join

          package = 'IPython'

          outdir = pjoin('source','api','generated')

          docwriter = ApiDocWriter(package,rst_extension='.txt')

          docwriter.package_skip_patterns += [r'\.fixes$',

                                              r'\.externals$',

                                              r'\.extensions',

                                              r'\.kernel.config',

                                              r'\.attic',

                                              r'\.quarantine',

                                              r'\.deathrow'

                                              ]

          docwriter.module_skip_patterns += [ r'\.core.fakemodule',

                                              r'\.cocoa',

                                              r'\.ipdoctest',

                                              r'\.Gnuplot',

                                              r'\.frontend.process.winprocess',

                                              ]

          docwriter.write_api_docs(outdir)

          docwriter.write_index(outdir, 'gen',

                                relative_to = pjoin('source','api')

                                )

          print '%d files written' % len(docwriter.written_modules)

	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
				"""Script to auto-generate our API docs.
				"""
				# stdlib imports
				import os
				import sys

				# local imports
				sys.path.append(os.path.abspath('sphinxext'))
				from apigen import ApiDocWriter

				#*****************************************************************************
				if __name__ == '__main__':
				pjoin = os.path.join
				package = 'IPython'
				outdir = pjoin('source','api','generated')
				docwriter = ApiDocWriter(package,rst_extension='.txt')
				docwriter.package_skip_patterns += [r'\.fixes$',
				r'\.externals$',
				r'\.extensions',
				r'\.kernel.config',
				r'\.attic',
				r'\.quarantine',
				r'\.deathrow'
				]
				docwriter.module_skip_patterns += [ r'\.core.fakemodule',
				r'\.cocoa',
				r'\.ipdoctest',
				r'\.Gnuplot',
				r'\.frontend.process.winprocess',
				]
				docwriter.write_api_docs(outdir)
				docwriter.write_index(outdir, 'gen',
				relative_to = pjoin('source','api')
				)
				print '%d files written' % len(docwriter.written_modules)