upstream/ipython Commit - r7825:b4c0a208

1

===========================================

1

===========================================

2

IPython: Productive Interactive Computing

2

IPython: Productive Interactive Computing

3

===========================================

3

===========================================

4

5

Overview

5

Overview

6

========

6

========

7

8

Welcome to IPython. Our full documentation is available on `our website

8

Welcome to IPython. Our full documentation is available on `our website

9

<http://ipython.org/documentation.html>`_; if you downloaded a built source

9

<http://ipython.org/documentation.html>`_; if you downloaded a built source

10

distribution the ``docs/source`` directory contains the plaintext version of

10

distribution the ``docs/source`` directory contains the plaintext version of

11

these manuals. If you have Sphinx installed, you can build them by typing

11

these manuals. If you have Sphinx installed, you can build them by typing

12

``make html`` for local browsing.

12

``cd docs; make html`` for local browsing.

13

14

15

Dependencies and supported Python versions

15

Dependencies and supported Python versions

16

==========================================

16

==========================================

17

18

For full details, see the installation section of the manual. The basic parts

18

For full details, see the installation section of the manual. The basic parts

19

of IPython only need the Python standard library, but much of its more advanced

19

of IPython only need the Python standard library, but much of its more advanced

20

functionality requires extra packages.

20

functionality requires extra packages.

21

22

Officially, IPython requires Python version 2.6, 2.7, or 3.1 and above.

22

Officially, IPython requires Python version 2.6, 2.7, or 3.1 and above.

23

24

25

Instant running

25

Instant running

26

===============

26

===============

27

28

You can run IPython from this directory without even installing it system-wide

28

You can run IPython from this directory without even installing it system-wide

29

by typing at the terminal::

29

by typing at the terminal::

30

31

$ python ipython.py

31

$ python ipython.py

	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

             ===========================================
              IPython: Productive Interactive Computing
             ===========================================
             Overview
             ========
             Welcome to IPython.  Our full documentation is available on `our website
             <http://ipython.org/documentation.html>`_; if you downloaded a built source
             distribution the ``docs/source`` directory contains the plaintext version of
             these manuals.  If you have Sphinx installed, you can build them by typing
-            ``make html`` for local browsing.
+            ``cd docs; make html`` for local browsing.
             Dependencies and supported Python versions
             ==========================================
             For full details, see the installation section of the manual.  The basic parts
             of IPython only need the Python standard library, but much of its more advanced
             functionality requires extra packages.
             Officially, IPython requires Python version 2.6, 2.7, or 3.1 and above.
             Instant running
             ===============
             You can run IPython from this directory without even installing it system-wide
             by typing at the terminal::
                $ python ipython.py