upstream/ipython Files · docs/source/development/template.py

Merge pull request from minrk/raw...

Merge pull request from minrk/raw rename plaintext cell -> raw cell Raw cells should be *untransformed* when writing various output formats, as the point of them is to let users pass through IPython to their rendered document format (rst, latex, etc.). This is different from what is the logical meaning of 'plaintext', which would suggest that the contents should be preserved as unformatted plaintext (e.g. in a `<pre>` tag, or literal block). In the UI, these cells will be displayed as 'Raw Text'. WARNING: any existing v3 notebooks which use plaintext cells, when read in by versions after this merge, will silently rename those cells to 'raw'. But if such a notebook is uploaded into a pre-merge IPython, cells labeled as 'raw' will simply *not be displayed*.

Fernando Perez - - Load All Authors

File last commit:

r3729:0c4144cd


                r6480:a0e0f391

Download file

             template.py
        
                    51 lines
            
             | 2.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / source / development / template.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Fernando Perez
    
Add template file to developer docs....

              r3206
            
      """A one-line description.

      A longer description that spans multiple lines.  Explain the purpose of the

      file and provide a short list of the key classes/functions it contains.  This

      is the docstring shown when some does 'import foo;foo?' in IPython, so it

      should be reasonably useful and informative.

      """

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

        Fernando Perez
    
Update copyright year in dev template file.

              r3729
            
      # Copyright (c) 2011, the IPython Development Team.

        Fernando Perez
    
Add template file to developer docs....

              r3206
            
      #

      # Distributed under the terms of the Modified BSD License.

      #

      # The full license is in the file COPYING.txt, distributed with this software.

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

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

      # Imports

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

      from __future__ import print_function

      # [remove this comment in production]

      #

      # List all imports, sorted within each section (stdlib/third-party/ipython).

      # For 'import foo', use one import per line.  For 'from foo.bar import a, b, c'

      # it's OK to import multiple items, use the parenthesized syntax 'from foo

      # import (a, b, ...)' if the list needs multiple lines.

      # Stdlib imports

      # Third-party imports

      # Our own imports

      # [remove this comment in production]

      #

      # Use broad section headers like this one that make it easier to navigate the

      # file, with descriptive titles.  For complex classes, simliar (but indented)

      # headers are useful to organize the internal class structure.

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

      # Globals and constants

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

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

      # Local utilities

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

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

      # Classes and functions

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

	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

Fernando Perez Add template file to developer docs....	r3206	"""A one-line description.

		A longer description that spans multiple lines. Explain the purpose of the
		file and provide a short list of the key classes/functions it contains. This
		is the docstring shown when some does 'import foo;foo?' in IPython, so it
		should be reasonably useful and informative.
		"""
		#-----------------------------------------------------------------------------
Fernando Perez Update copyright year in dev template file.	r3729	# Copyright (c) 2011, the IPython Development Team.
Fernando Perez Add template file to developer docs....	r3206	#
		# Distributed under the terms of the Modified BSD License.
		#
		# The full license is in the file COPYING.txt, distributed with this software.
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Imports
		#-----------------------------------------------------------------------------
		from __future__ import print_function

		# [remove this comment in production]
		#
		# List all imports, sorted within each section (stdlib/third-party/ipython).
		# For 'import foo', use one import per line. For 'from foo.bar import a, b, c'
		# it's OK to import multiple items, use the parenthesized syntax 'from foo
		# import (a, b, ...)' if the list needs multiple lines.

		# Stdlib imports

		# Third-party imports

		# Our own imports


		# [remove this comment in production]
		#
		# Use broad section headers like this one that make it easier to navigate the
		# file, with descriptive titles. For complex classes, simliar (but indented)
		# headers are useful to organize the internal class structure.

		#-----------------------------------------------------------------------------
		# Globals and constants
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Local utilities
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Classes and functions
		#-----------------------------------------------------------------------------