upstream/ipython Files · IPython/nbconvert/exporters/rst.py

Merge pull request from ivanov/doc-to-rst...

Merge pull request from ivanov/doc-to-rst This renames our documentation files to .rst so that it renders nicely on GitHub The docs build just fine with these changes, it'd be good to get this in before any more changes are made to the docs

Jonathan Frederic - - Load All Authors

File last commit:

r11634:7be59c0a


                r11764:79d36b57

Download file

             rst.py
        
                    42 lines
            
             | 1.4 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / rst.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Exporter for exporting notebooks to restructured text.

      """

      #-----------------------------------------------------------------------------

      # Copyright (c) 2013, the IPython Development Team.

      #

      # Distributed under the terms of the Modified BSD License.

      #

      # The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

      from IPython.utils.traitlets import Unicode

      from IPython.config import Config

      from .exporter import Exporter

      #-----------------------------------------------------------------------------

      # Classes

      #-----------------------------------------------------------------------------

      class RSTExporter(Exporter):

          """

          Exports restructured text documents.

          """

          file_extension = Unicode(

              'rst', config=True, 

              help="Extension of the file that should be written to disk")

          template_file = Unicode(

                  'rst', config=True,

                  help="Name of the template file to use")

          @property

          def default_config(self):

              c = Config({'ExtractOutputTransformer':{'enabled':True}})

              c.merge(super(RSTExporter,self).default_config)

              return c

	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

				"""
				Exporter for exporting notebooks to restructured text.
				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2013, the IPython Development Team.
				#
				# Distributed under the terms of the Modified BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				from IPython.utils.traitlets import Unicode
				from IPython.config import Config

				from .exporter import Exporter

				#-----------------------------------------------------------------------------
				# Classes
				#-----------------------------------------------------------------------------

				class RSTExporter(Exporter):
				"""
				Exports restructured text documents.
				"""

				file_extension = Unicode(
				'rst', config=True,
				help="Extension of the file that should be written to disk")

				template_file = Unicode(
				'rst', config=True,
				help="Name of the template file to use")

				@property
				def default_config(self):
				c = Config({'ExtractOutputTransformer':{'enabled':True}})
				c.merge(super(RSTExporter,self).default_config)
				return c