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

Fix docstring

Jonathan Frederic - - Load All Authors

File last commit:

r11733:6f6f75fb


                r11757:d95e89d5

Download file

             markdown.py
        
                    31 lines
            
             | 1.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / markdown.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Exporter that will export your ipynb to Markdown.

      """

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

      # 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 .exporter import Exporter

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

      # Classes

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

      class MarkdownExporter(Exporter):

          """

          Exports to a markdown document (.md)

          """

          file_extension = Unicode(

              'md', config=True, 

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

	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 that will export your ipynb to Markdown.
				"""
				#-----------------------------------------------------------------------------
				# 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 .exporter import Exporter

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

				class MarkdownExporter(Exporter):
				"""
				Exports to a markdown document (.md)
				"""

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