upstream/ipython Files · IPython/nbconvert/transformers/revealhelp.py

Exclude frontend shim from docs build...

Exclude frontend shim from docs build Closes gh-3517

MinRK - - Load All Authors

File last commit:

r11086:c137395d


                r11139:09d2ab5b

Download file

             revealhelp.py
        
                    51 lines
            
             | 2.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / transformers / revealhelp.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Jonathan Frederic
    
Cleanup and refactor, transformers

              r10674
            
      """Module that pre-processes the notebook for export via Reveal.

      """

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

      # 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

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

        Jonathan Frederic
    
Fixed all broken references, refactored some stuff here and there,...

              r10624
            
      from .base import ConfigurableTransformer

        Jonathan Frederic
    
Split transformer code

              r10437
            
        Jonathan Frederic
    
Cleanup and refactor, transformers

              r10674
            
      #-----------------------------------------------------------------------------

      # Classes and functions

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

        Jonathan Frederic
    
Fixed all broken references, refactored some stuff here and there,...

              r10624
            
      class RevealHelpTransformer(ConfigurableTransformer):

        Jonathan Frederic
    
Split transformer code

              r10437
            
        damianavila
    
Fixed css in template and call() in reveal help.

              r10851
            
          def call(self, nb, resources):

        Jonathan Frederic
    
Cleanup and refactor, transformers

              r10674
            
              """

              Called once to 'transform' contents of the notebook.

              Parameters

              ----------

              nb : NotebookNode

                  Notebook being converted

              resources : dictionary

                  Additional resources used in the conversion process.  Allows

                  transformers to pass variables into the Jinja engine.

              """

        Jonathan Frederic
    
Split transformer code

              r10437
            
              for worksheet in nb.worksheets :

                  for i, cell in enumerate(worksheet.cells):

        damianavila
    
Fixed reveal in the new nbconvert to make it work.

              r10823
            
                      #Make sure the cell has slideshow metadata.

        damianavila
    
Added changes to understand alignment metadata for each cells.

              r10947
            
                      cell.metadata.align_type = cell.get('metadata', {}).get('slideshow', {}).get('align_type', 'Left')

        damianavila
    
Fixed reveal in the new nbconvert to make it work.

              r10823
            
                      cell.metadata.slide_type = cell.get('metadata', {}).get('slideshow', {}).get('slide_type', '-')

        Jonathan Frederic
    
Cleanup and refactor, transformers

              r10674
            
                      #Get the slide type.  If type is start of subslide or slide,

                      #end the last subslide/slide.

        Jonathan Frederic
    
Split transformer code

              r10437
            
                      if cell.metadata.slide_type in ['slide']:

                          worksheet.cells[i - 1].metadata.slide_helper = 'slide_end'

                      if cell.metadata.slide_type in ['subslide']:

                          worksheet.cells[i - 1].metadata.slide_helper = 'subslide_end'

        Jonathan Frederic
    
Cleanup and refactor, transformers

              r10674
            
              return nb, resources

	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

Jonathan Frederic Cleanup and refactor, transformers	r10674	"""Module that pre-processes the notebook for export via Reveal.
		"""
		#-----------------------------------------------------------------------------
		# 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
		#-----------------------------------------------------------------------------

Jonathan Frederic Fixed all broken references, refactored some stuff here and there,...	r10624	from .base import ConfigurableTransformer
Jonathan Frederic Split transformer code	r10437
Jonathan Frederic Cleanup and refactor, transformers	r10674	#-----------------------------------------------------------------------------
		# Classes and functions
		#-----------------------------------------------------------------------------

Jonathan Frederic Fixed all broken references, refactored some stuff here and there,...	r10624	class RevealHelpTransformer(ConfigurableTransformer):
Jonathan Frederic Split transformer code	r10437
damianavila Fixed css in template and call() in reveal help.	r10851	def call(self, nb, resources):
Jonathan Frederic Cleanup and refactor, transformers	r10674	"""
		Called once to 'transform' contents of the notebook.

		Parameters
		----------
		nb : NotebookNode
		Notebook being converted
		resources : dictionary
		Additional resources used in the conversion process. Allows
		transformers to pass variables into the Jinja engine.
		"""


Jonathan Frederic Split transformer code	r10437	for worksheet in nb.worksheets :
		for i, cell in enumerate(worksheet.cells):
damianavila Fixed reveal in the new nbconvert to make it work.	r10823
		#Make sure the cell has slideshow metadata.
damianavila Added changes to understand alignment metadata for each cells.	r10947	cell.metadata.align_type = cell.get('metadata', {}).get('slideshow', {}).get('align_type', 'Left')
damianavila Fixed reveal in the new nbconvert to make it work.	r10823	cell.metadata.slide_type = cell.get('metadata', {}).get('slideshow', {}).get('slide_type', '-')

Jonathan Frederic Cleanup and refactor, transformers	r10674	#Get the slide type. If type is start of subslide or slide,
		#end the last subslide/slide.
Jonathan Frederic Split transformer code	r10437	if cell.metadata.slide_type in ['slide']:
		worksheet.cells[i - 1].metadata.slide_helper = 'slide_end'
		if cell.metadata.slide_type in ['subslide']:
		worksheet.cells[i - 1].metadata.slide_helper = 'subslide_end'
Jonathan Frederic Cleanup and refactor, transformers	r10674
		return nb, resources