upstream/ipython Files · IPython/nbformat/v2/convert.py

Fixed formatting errors in rmagic R() docstring...

Fixed formatting errors in rmagic R() docstring Things now mostly render correctly in both terminal and HTML versions of the docs. Note that there are still numerous warnings regarding these magics. At least some of them appear to be from the debauched manner in which the docs are being generated from the @magic_arguments. In addition to the warnings you get when building the docs, if you look at the HTML source for, e.g., rmagic, you'll see that the options are formatted in numerous ways. I get a "--" converted to an en-dash (–) for example. In case you're looking at this in a system that messes up the formatting of the HTML code-point above, the en-dash is 8211.

Brian E. Granger - - Load All Authors

File last commit:

r4609:a661b7c0


                r12536:ddcf4b0f

Download file

             convert.py
        
                    50 lines
            
             | 1.7 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbformat / v2 / convert.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Code for converting notebooks to and from the v2 format.

      Authors:

      * Brian Granger

      """

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

      #  Copyright (C) 2008-2011  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

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

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

      # Imports

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

      from .nbbase import (

          new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output

      )

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

      # Code

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

      def convert_to_this_nbformat(nb, orig_version=1):

          """Convert a notebook to the v2 format.

          Parameters

          ----------

          nb : NotebookNode

              The Python representation of the notebook to convert.

          orig_version : int

              The original version of the notebook to convert.

          """

          if orig_version == 1:

              newnb = new_notebook()

              ws = new_worksheet()

              for cell in nb.cells:

                  if cell.cell_type == u'code':

                      newcell = new_code_cell(input=cell.get('code'),prompt_number=cell.get('prompt_number'))

                  elif cell.cell_type == u'text':

                      newcell = new_text_cell(u'markdown',source=cell.get('text'))

                  ws.cells.append(newcell)

              newnb.worksheets.append(ws)

              return newnb

          else:

              raise ValueError('Cannot convert a notebook from v%s to v2' % orig_version)

	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

				"""Code for converting notebooks to and from the v2 format.

				Authors:

				* Brian Granger
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2011 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

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

				from .nbbase import (
				new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output
				)

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------

				def convert_to_this_nbformat(nb, orig_version=1):
				"""Convert a notebook to the v2 format.

				Parameters
				----------
				nb : NotebookNode
				The Python representation of the notebook to convert.
				orig_version : int
				The original version of the notebook to convert.
				"""
				if orig_version == 1:
				newnb = new_notebook()
				ws = new_worksheet()
				for cell in nb.cells:
				if cell.cell_type == u'code':
				newcell = new_code_cell(input=cell.get('code'),prompt_number=cell.get('prompt_number'))
				elif cell.cell_type == u'text':
				newcell = new_text_cell(u'markdown',source=cell.get('text'))
				ws.cells.append(newcell)
				newnb.worksheets.append(ws)
				return newnb
				else:
				raise ValueError('Cannot convert a notebook from v%s to v2' % orig_version)