upstream/ipython Files · docs/attic/nbexample.py

Updating the Sphinx docs in preparation for the release....

Updating the Sphinx docs in preparation for the release. I am going through the docs to make sure that i) there are no problems with the generation of the the Sphinx docs and ii) that our docs are an accurate reflection of the current state of the code. As of this commit, I have made a first pass at everything *except*: * Everything in the docs/source/interactive dir. This corresponds to most of the old IPython docs about the ipython shell. * The sections on the multiengine and task interfaces. Of course, this is just a first pass and we likely have lots more to do, but at least, our documentation exists and is no longer misleading or wrong.

Brian E Granger - - Load All Authors

File last commit:

r1248:19e3b286


                r1677:03e4c53a

Download file

             nbexample.py
        
                    11 lines
            
             | 268 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / attic / nbexample.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      from notebook.markup import rest

      rest.title('This is a Python Notebook')

      rest.heading(1,'A first-level heading')

      rest.text("""\

      Some plain text, without any special formatting.

      Below, we define a simple function to add two numbers.""")

      def add(x,y):

          return x+y

	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

				from notebook.markup import rest

				rest.title('This is a Python Notebook')
				rest.heading(1,'A first-level heading')
				rest.text("""\
				Some plain text, without any special formatting.

				Below, we define a simple function to add two numbers.""")

				def add(x,y):
				return x+y