|
2 | 2 | Documentation |
3 | 3 | ============= |
4 | 4 |
|
5 | | -IPython manual |
6 | | --------------- |
7 | | - |
8 | | -* `Current Stable Version (4.0) <https://ipython.readthedocs.org/en/stable>`_ |
9 | | -* `Current Development Version <https://ipython.readthedocs.org/en/latest>`_ |
10 | | - |
11 | | -You can download IPython documentation for offline use, and for all version of IPython on |
12 | | -`GitHub <https://github.com/ipython/ipython-doc/tree/gh-pages>`_. |
13 | | - |
14 | | -`This introduction to some key features |
15 | | -<http://ipython.org/ipython-doc/stable/interactive/tutorial.html>`_ is a good |
16 | | -place to start if you haven't used IPython before. |
17 | | - |
18 | | -See below_ for links to all versions of the documentation. |
19 | | - |
20 | | -.. _below: docs_all_releases_ |
21 | | - |
22 | | - |
23 | | -Other useful documentation |
24 | | --------------------------- |
25 | | - |
26 | | -* `Presentations <presentation.html>`_ we've |
27 | | - given at various venues regarding IPython over the years. |
28 | | -* `Videos and screencasts <videos.html>`_. |
29 | | -* IPython `screenshots <screenshots/index.html>`_. |
30 | | -* `IPython quick reference card |
31 | | - <https://damontallen.github.io/IPython-quick-ref-sheets/>`_. |
32 | | -* An `article about IPython |
33 | | - <http://fperez.org/papers/ipython07_pe-gr_cise.pdf>`_, written by Fernando |
34 | | - Perez and Brian Granger, published in the `May/June 2007 issue |
35 | | - <http://scitation.aip.org/content/aip/journal/cise/9/3>`_ of |
36 | | - the journal *Computing in Science and Engineering*. |
37 | | - |
38 | | -External documentation, related presentations and tutorials |
39 | | ------------------------------------------------------------ |
40 | | - |
41 | | -This is a collection of presentations, often by authors outside of the core |
42 | | -IPython team. Some are focused on aspects of IPython itself while others may be |
43 | | -about external projects that use IPython as a key component. If you have any |
44 | | -material that fits this description, please contact the IPython team and let us |
45 | | -know about it so we can post it here. |
46 | | - |
47 | | -* The `BCPy2000 project <http://bci2000.org/downloads/BCPy2000/About.html>`_ |
48 | | - offers Python tools for Brain-Computer interface development, and it uses |
49 | | - IPython in a really neat way to enable interactive debugging of all the |
50 | | - components as they operate in real-time. `This talk |
51 | | - <http://videolectures.net/mloss08_hill_bcpy/>`_ presented at the 2008 NIPS |
52 | | - conference shows the system. |
53 | | -* `Jose Unpingco <https://www.linkedin.com/pub/jose-unpingco/1/16/299>`_ made this really neat |
54 | | - `screencast <http://showmedo.com/videotutorials/series?name=XCsI4bsup>`_ showing how |
55 | | - to couple IPython's parallel capabilities with the `Vision |
56 | | - <http://mgltools.scripps.edu/packages/vision>`_ environment. Vision is an extremely |
57 | | - impressive visual programming environment developed by `Michel Sanner's |
58 | | - <http://www.scripps.edu/sanner>`_ team at the Scripps Institute in La Jolla, |
59 | | - CA. |
60 | | -* An `article |
61 | | - <http://magazine.redhat.com/2008/02/07/python-for-bash-scripters-a-well-kept-secret/>`__ |
62 | | - by Noah Gift on RedHat Magazine that covers using Python, and IPython, as a |
63 | | - better Bash. |
64 | | -* An `article |
65 | | - <https://www.ibm.com/developerworks/aix/library/au-netsnmpnipython>`__ by Noah |
66 | | - Gift at the IBM Developer Works site, on using the Net-SNMP library to |
67 | | - interactively explore and manage a network (the interactive part courtesy of |
68 | | - IPython, of course). |
69 | | -* A `post and video |
70 | | - <http://blog.boucault.net/post/2007/12/10/IPython-and-Pigment-simplicity>`_ |
71 | | - about using IPython's GTK support to interactively control a `Pigment |
72 | | - <https://code.fluendo.com/pigment/trac>`_ application. It also uses the |
73 | | - IPython demo class. |
74 | | -* An `article <http://archive09.linux.com/feature/47635>`__ at Linux.com about |
75 | | - IPython, by Conrad Koziol. |
76 | | -* An `article <http://www.onlamp.com/pub/a/python/2005/01/27/ipython.html>`__ by |
77 | | - Jeremy Jones at ONLamp.com, introducing IPython to new users and giving a |
78 | | - tour of its features as a replacement for the default Python shell. |
79 | | -* The O'Reilly book `"Python for Unix and Linux System Administration" |
80 | | - <http://shop.oreilly.com/product/9780596515829.do>`_ has a chapter (the first, and |
81 | | - largest one) on IPython. IPython is also used throughout the book to |
82 | | - illustrate other Python technologies. |
83 | | - |
84 | | -Other projects using IPython |
85 | | ----------------------------- |
| 5 | +Current Documentation |
| 6 | +--------------------- |
86 | 7 |
|
87 | | -`Here <https://github.com/ipython/ipython/wiki/Projects-using-IPython>`_ you can |
88 | | -find a list of projects that use IPython in one form or another. If you use |
89 | | -IPython as part of a project, please do add your information to this page or |
90 | | -email `Fernando.Perez@Berkeley.edu <mailto:Fernando.Perez@Berkeley.edu>`_ and |
91 | | -I'll be happy to add it. Also, if your project is of academic relevance, |
92 | | -please `provide a citation to IPython <citing.html>`_. |
| 8 | +IPython is developed as a set of Subprojects under the larger Project Jupyter umbrella. The documentation of each Subproject is now being hosted on `Read the Docs <https://readthedocs.org/>`_: |
93 | 9 |
|
94 | | -.. footer:: |
| 10 | +`Main Documentation Site for Jupyter and IPython <http://jupyter.readthedocs.org/en/latest/>`_ |
95 | 11 |
|
96 | | - These documents themselves are maintained as a `git repository |
97 | | - <https://github.com/ipython/ipython-doc>`_ on GitHub, using the `GitHub |
98 | | - project pages feature <https://pages.github.com/>`_. |
| 12 | +This website includes the documentation for the Jupyter Notebook as well as the IPython kernel |
| 13 | +and other related projects. |
99 | 14 |
|
100 | | - |
101 | 15 | .. _docs_all_releases: |
102 | 16 |
|
103 | | -Docs for all releases |
104 | | ---------------------- |
| 17 | +Documentation for previous releases |
| 18 | +----------------------------------- |
105 | 19 |
|
106 | 20 | * `3.x <http://ipython.org/ipython-doc/3/index.html>`__ |
107 | 21 | * `2.x <http://ipython.org/ipython-doc/2/index.html>`__ |
|
0 commit comments