upstream/ipython Files · IPython/sphinxext/ipython_console_highlighting.py

whats new 8.13 (#14050)

Michael Droettboom - - Load All Authors

File last commit:

r21874:3ffdf6f9


                r28267:4fa5fccb

Download file

             ipython_console_highlighting.py
        
                    28 lines
            
             | 970 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / sphinxext / ipython_console_highlighting.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      """

        chebee7i
    
Update code for making sphinx aware of IPython console lexer.

              r13631
            
      reST directive for syntax-highlighting ipython interactive sessions.

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
        chebee7i
    
Update code for making sphinx aware of IPython console lexer.

              r13631
            
      """

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
        Fernando Perez
    
Add the matplotlib sphinx extensions, authored by the MPL team.

              r1694
            
      from sphinx import highlighting

        Thomas Kluyver
    
Move IPython lexers module to lib...

              r20625
            
      from IPython.lib.lexers import IPyLexer

        Brian Granger
    
Cleanup of docs....

              r2275
            
      def setup(app):

          """Setup as a sphinx extension."""

          # This is only a lexer, so adding it below to pygments appears sufficient.

        chebee7i
    
Update code for making sphinx aware of IPython console lexer.

              r13631
            
          # But if somebody knows what the right API usage should be to do that via

        Brian Granger
    
Cleanup of docs....

              r2275
            
          # sphinx, by all means fix it here.  At least having this setup.py

          # suppresses the sphinx warning we'd get without it.

        Michael Droettboom
    
Support parallel sphinx building

              r21874
            
          metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}

          return metadata

        Brian Granger
    
Cleanup of docs....

              r2275
            
        chebee7i
    
lexerself -> lexer.

              r13652
            
      # Register the extension as a valid pygments lexer.

        chebee7i
    
Update code for making sphinx aware of IPython console lexer.

              r13631
            
      # Alternatively, we could register the lexer with pygments instead. This would

      # require using setuptools entrypoints: http://pygments.org/docs/plugins

        chebee7i
    
Clean up aliases for lexers.

              r13864
            
      ipy2 = IPyLexer(python3=False)

        chebee7i
    
Update code for making sphinx aware of IPython console lexer.

              r13631
            
      ipy3 = IPyLexer(python3=True)

        chebee7i
    
Clean up aliases for lexers.

              r13864
            
      highlighting.lexers['ipython'] = ipy2

      highlighting.lexers['ipython2'] = ipy2

        chebee7i
    
Make IPyLexer available in Pygments as 'ipython' and 'ipython3'.

              r13633
            
      highlighting.lexers['ipython3'] = ipy3

	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

Fernando Perez Update docs for automatic API building.	r1850	"""
chebee7i Update code for making sphinx aware of IPython console lexer.	r13631	reST directive for syntax-highlighting ipython interactive sessions.
Fernando Perez Update docs for automatic API building.	r1850
chebee7i Update code for making sphinx aware of IPython console lexer.	r13631	"""
Fernando Perez Update docs for automatic API building.	r1850
Fernando Perez Add the matplotlib sphinx extensions, authored by the MPL team.	r1694	from sphinx import highlighting
Thomas Kluyver Move IPython lexers module to lib...	r20625	from IPython.lib.lexers import IPyLexer
Brian Granger Cleanup of docs....	r2275
		def setup(app):
		"""Setup as a sphinx extension."""

		# This is only a lexer, so adding it below to pygments appears sufficient.
chebee7i Update code for making sphinx aware of IPython console lexer.	r13631	# But if somebody knows what the right API usage should be to do that via
Brian Granger Cleanup of docs....	r2275	# sphinx, by all means fix it here. At least having this setup.py
		# suppresses the sphinx warning we'd get without it.
Michael Droettboom Support parallel sphinx building	r21874	metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
		return metadata
Brian Granger Cleanup of docs....	r2275
chebee7i lexerself -> lexer.	r13652	# Register the extension as a valid pygments lexer.
chebee7i Update code for making sphinx aware of IPython console lexer.	r13631	# Alternatively, we could register the lexer with pygments instead. This would
		# require using setuptools entrypoints: http://pygments.org/docs/plugins

chebee7i Clean up aliases for lexers.	r13864	ipy2 = IPyLexer(python3=False)
chebee7i Update code for making sphinx aware of IPython console lexer.	r13631	ipy3 = IPyLexer(python3=True)

chebee7i Clean up aliases for lexers.	r13864	highlighting.lexers['ipython'] = ipy2
		highlighting.lexers['ipython2'] = ipy2
chebee7i Make IPyLexer available in Pygments as 'ipython' and 'ipython3'.	r13633	highlighting.lexers['ipython3'] = ipy3