From f658828f5de8b96bdf81074c583e294608980093 2008-06-09 22:47:41 From: Brian E Granger Date: 2008-06-09 22:47:41 Subject: [PATCH] Cleaning up the IPython docs. I have removed old README files that were outdated and being maintained in the top-level dir. I have removed all mentions of the old lyx based docs. Created subdirectories for man and emacs stuff. Having fun. --- diff --git a/COPYING.txt b/COPYING.txt index 1e0939c..96ad879 100644 --- a/COPYING.txt +++ b/COPYING.txt @@ -32,6 +32,9 @@ POSSIBILITY OF SUCH DAMAGE. About the IPython Development Team ---------------------------------- +Fernando Perez began IPython in 2001 based on code from Janko Hauser +and Nathaniel Gray . Fernando is still the project lead. + The IPython Development Team is the set of all contributors to the IPython project. This includes all of the IPython subprojects. Here is a list of the currently active contributors: @@ -48,7 +51,7 @@ This includes all of the IPython subprojects. Here is a list of the currently ac * Tech-X Corporation * Barry Wark -If your name is missing, please add it. +If your name is missing, please add it. Our Copyright Policy -------------------- diff --git a/README.txt b/README.txt index aec04be..a46aaeb 100644 --- a/README.txt +++ b/README.txt @@ -1,11 +1,11 @@ -Please see the doc/ directory for full manuals and other documents. The manual is -prepared using the LyX system (www.lyx.org), but in the doc/manual directory -you'll find HTML and PDF versions. +=============== +IPython1 README +=============== + +.. contents:: -These manuals normally get installed to $PREFIX/share/doc/ipython-VERSION, unless you -redirect the installer via a --prefix/--home option. Normally, $PREFIX is -/usr, but your Python may be installed elsewhere. You can see its value by -running: - -python -c "import sys;print sys.prefix" +Overview +======== +Welcome to IPython. New users should consult our documentation, which can be found +in the docs/source subdirectory. diff --git a/docs/README.txt b/docs/README.txt deleted file mode 100644 index 6a6745a..0000000 --- a/docs/README.txt +++ /dev/null @@ -1,14 +0,0 @@ -Current version information ---------------------------- - -Please open manual.pdf for a PDF version of IPython's user manual, or go to -the manual/ directory for an HTML version. - - -Bugs and future developments ----------------------------- - -The new_design.pdf document is a description of the goals for IPython's future -development. It includes a TODO/bugs section listing all currently known bugs -in IPython. Please report any bug you encounter if it is not already listed -there. diff --git a/docs/README_Windows.txt b/docs/README_Windows.txt deleted file mode 100644 index 0f90694..0000000 --- a/docs/README_Windows.txt +++ /dev/null @@ -1,39 +0,0 @@ -Notes for Windows Users -======================= - -These are just minimal notes. The manual contains more detailed -information. - -Requirements ------------- - -IPython runs under (as far as the Windows family is concerned): - -- Windows XP (I think WinNT/2000 are ok): works well. It needs: - - * Gary Bishop's readline from - http://sourceforge.net/projects/uncpythontools. - - * This in turn requires Tomas Heller's ctypes from - http://starship.python.net/crew/theller/ctypes. - -- Windows 95/98/ME: I have no idea. It should work, but I can't test. - -- CygWin environments should work, they are basically Posix. - -It needs Python 2.2 or newer. - - -Installation ------------- - -Double-click the supplied .exe installer file. If all goes well, that's all -you need to do. You should now have an IPython entry in your Start Menu. - -In case the automatic installer does not work for some reason, you can -download the ipython-XXX.tar.gz file, which contains the full IPython source -distribution (the popular WinZip can read .tar.gz files). After uncompressing -the archive, you can install it at a command terminal just like any other -Python module, by using python setup.py install'. After this completes, you -can run the supplied win32_manual_post_install.py script which will add -the relevant shortcuts to your startup menu. diff --git a/docs/COPYING b/docs/attic/COPYING similarity index 100% rename from docs/COPYING rename to docs/attic/COPYING diff --git a/docs/ipython.el b/docs/emacs/ipython.el similarity index 100% rename from docs/ipython.el rename to docs/emacs/ipython.el diff --git a/docs/ipython.1 b/docs/man/ipython.1 similarity index 100% rename from docs/ipython.1 rename to docs/man/ipython.1 diff --git a/docs/pycolor.1 b/docs/man/pycolor.1 similarity index 100% rename from docs/pycolor.1 rename to docs/man/pycolor.1 diff --git a/docs/api_changes.txt b/docs/source/api_changes.txt similarity index 100% rename from docs/api_changes.txt rename to docs/source/api_changes.txt diff --git a/docs/update_version.sh b/docs/update_version.sh deleted file mode 100755 index 4e09ef0..0000000 --- a/docs/update_version.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh -ver=`ipython -V` -sed "s/__version__/${ver}/" manual_base.lyx > manual.lyx