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

Update signature presentation in pinfo classes...

Update signature presentation in pinfo classes classes: - init definition comes before class docstring - remove Constructor info block, because it no longer has multiple entries - don't include instance call definition as definition objects: - don't duplicate call def and definition in callables

Thomas Kluyver - - Load All Authors

File last commit:

r13933:5a8a8ea9


                r15711:bbbaecf3

Download file

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

      """Markdown Exporter class"""

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

      # 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.config import Config

      from .templateexporter import TemplateExporter

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

      # Classes

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

      class MarkdownExporter(TemplateExporter):

          """

          Exports to a markdown document (.md)

          """

          def _file_extension_default(self):

              return 'md'

          def _template_file_default(self):

              return 'markdown'

          output_mimetype = 'text/markdown'

          def _raw_mimetypes_default(self):

              return ['text/markdown', 'text/html', '']

          @property

          def default_config(self):

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

              c.merge(super(MarkdownExporter,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

				"""Markdown Exporter class"""

				#-----------------------------------------------------------------------------
				# 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.config import Config

				from .templateexporter import TemplateExporter

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

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

				def _file_extension_default(self):
				return 'md'

				def _template_file_default(self):
				return 'markdown'

				output_mimetype = 'text/markdown'

				def _raw_mimetypes_default(self):
				return ['text/markdown', 'text/html', '']

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