In documentation, say that LinExpr.__eq__() does not return a Polyhedron

[linpy.git] / doc / install.rst

diff --git a/doc/install.rst b/doc/install.rst
index 9b4b97c..2d7883b 100644 (file)
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -1,15 +1,20 @@
 
 

+.. _install:
+

 Installation
 ============
 
 Installation
 ============
 

+
+.. _install_dep:
+

 Dependencies
 ------------
 
 LinPy requires Python version 3.4 or above to work.
 
 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).
 Dependencies
 ------------
 
 LinPy requires Python version 3.4 or above to work.
 
 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 distribution's package manager.
-For Ubuntu, the command to run is::
+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
 
 
     sudo apt-get install libisl-dev
 


@@ -20,27 +25,31 @@ For Arch Linux, run::
 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#how-to-install>`_ to install these libraries.
 
 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#how-to-install>`_ to install these libraries.
 

-pip
----
+
+.. _install_pip:
+
+Install Using pip
+-----------------

 
 .. warning::
 
     The project has not been published in PyPI yet, so this section is not relevant.
 
 .. 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
 
 
 LinPy can be installed using pip with the command::
 
     sudo pip install linpy
 

-.. _source:

 
 

-Source
-------
+.. _install_source:
+
+Install From Source
+-------------------

 
 Alternatively, LinPy can be installed from the source.
 First, clone the public git repository::
 
 
 Alternatively, LinPy can be installed from the source.
 First, clone the public git repository::
 

-    git clone https://scm.cri.ensmp.fr/git/linpy.git
+    git clone https://scm.cri.mines-paristech.fr/git/linpy.git

 
 and build and install as usual with::
 
 
 and build and install as usual with::