Replace examples by tutorial in documentation
[linpy.git] / doc / install.rst
index 040029d..92aad27 100644 (file)
@@ -1,4 +1,6 @@
 
+.. _install:
+
 Installation
 ============
 
@@ -7,9 +9,9 @@ Dependencies
 
 LinPy requires Python version 3.4 or above to work.
 
-LinPy's one mandatory dependency is isl version 0.12 or 0.13 (it may work with other versions of isl, but this has not been tested).
-isl can be downloaded `here <http://freshmeat.net/projects/isl/>`_ or preferably, using your favorite distribution's package manager.
-For Ubuntu, the command to run is::
+LinPy's one mandatory dependency is `isl <http://isl.gforge.inria.fr/>`_ version 0.12 or 0.13 (it may work with other versions of isl, but this has not been tested).
+isl can be downloaded `here <http://freshmeat.net/projects/isl/>`_ or preferably, using your favorite package manager.
+For Debian or Ubuntu, the command to run is::
 
     sudo apt-get install libisl-dev
 
@@ -18,32 +20,26 @@ For Arch Linux, run::
     sudo pacman -S isl
 
 Apart from isl, there are two optional dependencies that will maximize the use of LinPy's functions: `SymPy <http://sympy.org/en/index.html>`_ and `matplotlib <http://matplotlib.org/>`_.
-Please consult the `SymPy download page <http://sympy.org/en/download.html>`_ and `matplotlib installation instructions <http://matplotlib.org/faq/installing_faq.html>`_ to install these libraries.
+Please consult the `SymPy download page <http://sympy.org/en/download.html>`_ and `matplotlib installation instructions <http://matplotlib.org/faq/installing_faq.html#how-to-install>`_ to install these libraries.
 
-pip
----
+Install Using pip
+-----------------
 
 .. warning::
 
     The project has not been published in PyPI yet, so this section is not relevant.
-    Instead, see the :ref:`source` section to install LinPy.
+    Instead, see the :ref:`install_source` section to install LinPy.
 
 LinPy can be installed using pip with the command::
 
     sudo pip install linpy
 
-.. _here: http://freshmeat.net/projects/isl/
-
-.. _download page: http://sympy.org/en/download.html
-
-.. _link: http://matplotlib.org/faq/installing_faq.html
-
-.. _source:
+.. _install_source:
 
-Source
-------
+Install From Source
+-------------------
 
-Alternatively, LinPy can be installed from source.
+Alternatively, LinPy can be installed from the source.
 First, clone the public git repository::
 
     git clone https://scm.cri.ensmp.fr/git/linpy.git