upstream/ipython Files · docs/autogen_api.py

Remove svn-style $Id marks from docstrings and Release imports....

Remove svn-style $Id marks from docstrings and Release imports. The Id marks show up as junk in the API docs (and they were outdated anyway, since we now use bzr). The Release imports were in there for pulling author/license information for epydoc, but now with sphinx they aren't necessary, and they just are extra startup work.

Fernando Perez - - Load All Authors

File last commit:

r1850:d536fe7e


                r1853:b8f5152c

Download file

             autogen_api.py
        
                    33 lines
            
             | 1.2 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',

                                              ]

          docwriter.module_skip_patterns += [ r'\.FakeModule',

                                              r'\.cocoa',

                                              r'\.ipdoctest',

                                              r'\.Gnuplot',

                                              ]

          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',
				]
				docwriter.module_skip_patterns += [ r'\.FakeModule',
				r'\.cocoa',
				r'\.ipdoctest',
				r'\.Gnuplot',
				]
				docwriter.write_api_docs(outdir)
				docwriter.write_index(outdir, 'gen',
				relative_to = pjoin('source','api')
				)
				print '%d files written' % len(docwriter.written_modules)