upstream/ipython Files · IPython/nbconvert/writers/base.py

semantic names for indicator icons...

semantic names for indicator icons For all of the discussion that we had about what kind of icons should and should not be used to indicate what mode the notebook is in, we never went through to make it possible to override it. With this change, it is now possible to override what icons are displayed for Command and Edit Modes. For example, @minrk liked the fighter-jet icon for Command Mode, so he can put this in his custom.css .ipython-command-mode:before { content: "\f0fb"; }

Paul Ivanov - - Load All Authors

File last commit:

r12222:1ec6f582


                r15806:6b3b303a

Download file

             base.py
        
                    56 lines
            
             | 1.7 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / writers / base.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Contains writer base 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.utils.traitlets import List

      from ..utils.base import NbConvertBase

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

      # Classes

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

      class WriterBase(NbConvertBase):

          """Consumes output from nbconvert export...() methods and writes to a

          useful location. """

          files = List([], config=True, help="""

              List of the files that the notebook references.  Files will be 

              included with written output.""")

          def __init__(self, config=None, **kw):

              """

              Constructor

              """

              super(WriterBase, self).__init__(config=config, **kw)

          def write(self, output, resources, **kw):

              """

              Consume and write Jinja output.

              Parameters

              ----------

              output : string

                  Conversion results.  This string contains the file contents of the

                  converted file.

              resources : dict

                  Resources created and filled by the nbconvert conversion process.

                  Includes output from preprocessors, such as the extract figure

                  preprocessor.

              """

              raise NotImplementedError()

	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

				"""
				Contains writer base 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.utils.traitlets import List

				from ..utils.base import NbConvertBase

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

				class WriterBase(NbConvertBase):
				"""Consumes output from nbconvert export...() methods and writes to a
				useful location. """


				files = List([], config=True, help="""
				List of the files that the notebook references. Files will be
				included with written output.""")


				def __init__(self, config=None, **kw):
				"""
				Constructor
				"""
				super(WriterBase, self).__init__(config=config, **kw)


				def write(self, output, resources, **kw):
				"""
				Consume and write Jinja output.

				Parameters
				----------
				output : string
				Conversion results. This string contains the file contents of the
				converted file.
				resources : dict
				Resources created and filled by the nbconvert conversion process.
				Includes output from preprocessors, such as the extract figure
				preprocessor.
				"""

				raise NotImplementedError()