upstream/ipython Files · docs/autogen_api.py

refactor to improve cell switching in edit mode...

refactor to improve cell switching in edit mode This code was repeated in both CodeCell and TextCell, both of which are extensions of Cell, so this just unifies the logic in Cell. TextCell had logic here to check if the cell was rendered or not, but I don't believe it is possible to end up triggering such a code path. (Should that be required, I can always just add back these methods to TextCell, performing the .rendered==True check, and calling the Cell prior to this, code mirror at_top would only return true on if the cursor was at the first character of the top line. Now, pressing up arrow on any character on the top line will take you to the cell above. The same applies for the bottom line. Pressing down arrow would only go to the next cell if the cursor was at a location *after* the last character (something that is only possible to achieve in vim mode if the last line is empty, for example). Now, down arrow on any character of the last line will go to the next cell.

Kyle Kelley - - Load All Authors

File last commit:

r15317:92e068ab


                r15754:d60e793e

Download file

             autogen_api.py
        
                    45 lines
            
             | 1.9 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='.rst')

          # You have to escape the . here because . is a special char for regexps.

          # You must do make clean if you change this!

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

                                              # Extensions are documented elsewhere.

                                              r'\.extensions',

                                              r'\.config\.profile',

                                              ]

          # The inputhook* modules often cause problems on import, such as trying to

          # load incompatible Qt bindings. It's easiest to leave them all out. The

          # main API is in the inputhook module, which is documented.

          docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',

                                              r'\.ipdoctest',

                                              r'\.testing\.plugin',

                                              # This just prints a deprecation msg:

                                              r'\.frontend$',

                                              # We document this manually.

                                              r'\.utils\.py3compat',

                                              ]

          # Now, generate the outputs

          docwriter.write_api_docs(outdir)

          # Write index with .txt extension - we can include it, but Sphinx won't try

          # to compile it

          docwriter.write_index(outdir, 'gen.txt',

                                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='.rst')
				# You have to escape the . here because . is a special char for regexps.
				# You must do make clean if you change this!
				docwriter.package_skip_patterns += [r'\.external$',
				# Extensions are documented elsewhere.
				r'\.extensions',
				r'\.config\.profile',
				]

				# The inputhook* modules often cause problems on import, such as trying to
				# load incompatible Qt bindings. It's easiest to leave them all out. The
				# main API is in the inputhook module, which is documented.
				docwriter.module_skip_patterns += [ r'\.lib\.inputhook.+',
				r'\.ipdoctest',
				r'\.testing\.plugin',
				# This just prints a deprecation msg:
				r'\.frontend$',
				# We document this manually.
				r'\.utils\.py3compat',
				]

				# Now, generate the outputs
				docwriter.write_api_docs(outdir)
				# Write index with .txt extension - we can include it, but Sphinx won't try
				# to compile it
				docwriter.write_index(outdir, 'gen.txt',
				relative_to = pjoin('source','api')
				)
				print ('%d files written' % len(docwriter.written_modules))