upstream/ipython Files · docs/source/install/index.rst

Improve async detection mechanism with blacklist...

Improve async detection mechanism with blacklist Because the async repl works by wrapping any code that raises SyntaxError in an async function and trying to execute it again, cell bodies that are invalid at the top level but valid in functions and methods (e.g. return and yield statements) currently allow executing invalid code. This patch blacklists return and yield statements outside of a function or method to restore the proper SyntaxError behavior.

Gavin Cooper - - Load All Authors

File last commit:

r22679:367c6fe3


                r24485:c4bf6326

Download file

             index.rst
        
                    58 lines
            
             | 1.1 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / source / install / index.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Brian E Granger
    
Updated the main introduction to IPython in the Sphinx docs.

              r1400
            
      .. _install_index:

        Fernando Perez
    
Documentation updates....

              r1753
            
      ============

        Brian E Granger
    
Massive reorganization of the IPython documentation.  It is now ready to be hacked on by users.  ...

              r1258
            
      Installation

        Fernando Perez
    
Documentation updates....

              r1753
            
      ============

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      .. toctree::

        Matthias Bussonnier
    
Documentation overhaul....

              r22588
            
         :maxdepth: 3

         :hidden:

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
        Paul Ivanov
    
update indexes to use .rst, remove .txt refs

              r11730
            
         install

        Jonathan Frederic
    
Add files remove in https://github.com/jupyter/notebook/pull/124

              r21584
            
         kernel_install

        Brian Granger
    
Cleanup of docs....

              r2275
            
        Matthias Bussonnier
    
Documentation overhaul....

              r22588
            
        Gavin Cooper
    
Fix broken links on install/index.rst...

              r22679
            
      This sections will guide you through :ref:`installing IPython itself <install>`, and

      installing :ref:`kernels for Jupyter <kernel_install>` if you wish to work with

        Carol Willing
    
First pass at editing pr

              r22594
            
      multiple version of Python, or multiple environments.

        Matthias Bussonnier
    
Documentation overhaul....

              r22588
            
      Quick install reminder

      ~~~~~~~~~~~~~~~~~~~~~~

        Carol Willing
    
First pass at editing pr

              r22594
            
      Here is a quick reminder of the commands needed for installation if you are

      already familiar with IPython and are just searching to refresh your memory:

        Matthias Bussonnier
    
Documentation overhaul....

              r22588
            
      Install IPython:

      .. code-block:: bash

          $ pip install ipython

      Install and register an IPython kernel with Jupyter:

      .. code-block:: bash

          $ python -m pip install ipykernel

          $ python -m ipykernel install [--user] [--name <machine-readable-name>] [--display-name <"User Friendly Name">]

      for more help see 

      .. code-block:: bash

          $ python -m ipykernel install  --help

      .. seealso::

         `Installing Jupyter <http://jupyter.readthedocs.io/en/latest/install.html>`__

           The Notebook, nbconvert, and many other former pieces of IPython are now

           part of Project Jupyter.

	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

Brian E Granger Updated the main introduction to IPython in the Sphinx docs.	r1400	.. _install_index:

Fernando Perez Documentation updates....	r1753	============
Brian E Granger Massive reorganization of the IPython documentation. It is now ready to be hacked on by users. ...	r1258	Installation
Fernando Perez Documentation updates....	r1753	============
Brian E Granger Beginning to organize the rst documentation.	r1256
		.. toctree::
Matthias Bussonnier Documentation overhaul....	r22588	:maxdepth: 3
		:hidden:

Brian E Granger Beginning to organize the rst documentation.	r1256
Paul Ivanov update indexes to use .rst, remove .txt refs	r11730	install
Jonathan Frederic Add files remove in https://github.com/jupyter/notebook/pull/124	r21584	kernel_install
Brian Granger Cleanup of docs....	r2275
Matthias Bussonnier Documentation overhaul....	r22588

Gavin Cooper Fix broken links on install/index.rst...	r22679	This sections will guide you through :ref:`installing IPython itself <install>`, and
		installing :ref:`kernels for Jupyter <kernel_install>` if you wish to work with
Carol Willing First pass at editing pr	r22594	multiple version of Python, or multiple environments.
Matthias Bussonnier Documentation overhaul....	r22588

		Quick install reminder
		~~~~~~~~~~~~~~~~~~~~~~

Carol Willing First pass at editing pr	r22594	Here is a quick reminder of the commands needed for installation if you are
		already familiar with IPython and are just searching to refresh your memory:
Matthias Bussonnier Documentation overhaul....	r22588
		Install IPython:

		.. code-block:: bash

		$ pip install ipython


		Install and register an IPython kernel with Jupyter:


		.. code-block:: bash

		$ python -m pip install ipykernel

		$ python -m ipykernel install [--user] [--name <machine-readable-name>] [--display-name <"User Friendly Name">]

		for more help see

		.. code-block:: bash

		$ python -m ipykernel install --help



		.. seealso::

		`Installing Jupyter <http://jupyter.readthedocs.io/en/latest/install.html>`__
		The Notebook, nbconvert, and many other former pieces of IPython are now
		part of Project Jupyter.