]> CRI, Mines Paris - PSL - linpy.git/commitdiff
Add labels to documentation sections
authorVivien Maisonneuve <v.maisonneuve@gmail.com>
Wed, 20 Aug 2014 08:14:18 +0000 (10:14 +0200)
committerVivien Maisonneuve <v.maisonneuve@gmail.com>
Wed, 20 Aug 2014 08:14:18 +0000 (10:14 +0200)
doc/index.rst
doc/install.rst
doc/reference.rst
doc/tutorial.rst

index fee1edfc429175c6c387975f52d872c62e760b33..ce346f1c31a36537b929913e89b9194e4dfcf629 100644 (file)
@@ -8,8 +8,8 @@ Integer Set Library (isl) is a C library for manipulating sets and relations of
 LinPy is a free software, licensed under the `GPLv3 license <http://www.gnu.org/licenses/gpl-3.0.txt>`_.
 Its source code is available `here <https://scm.cri.mines-paristech.fr/git/linpy.git>`_.
 
 LinPy is a free software, licensed under the `GPLv3 license <http://www.gnu.org/licenses/gpl-3.0.txt>`_.
 Its source code is available `here <https://scm.cri.mines-paristech.fr/git/linpy.git>`_.
 
-To have an overview of LinPy's features, you may wish to consult the :ref:`tutorial` section.
-For a comprehensive description of its functionalities, see the :ref:`reference` section.
+To have an overview of LinPy's features, you may wish to read the :ref:`tutorial`.
+For a comprehensive description of its functionalities, please consult the :ref:`reference`.
 
 .. only:: html
 
 
 .. only:: html
 
@@ -22,6 +22,7 @@ For a comprehensive description of its functionalities, see the :ref:`reference`
     tutorial.rst
     reference.rst
 
     tutorial.rst
     reference.rst
 
+
 .. only:: html
 
     Indices and tables
 .. only:: html
 
     Indices and tables
index f5c1c9e570a3d1af7ab9c6de527dd988e884ab25..2d7883b119b3b1ee40c946c348df7205548d68e8 100644 (file)
@@ -4,6 +4,9 @@
 Installation
 ============
 
 Installation
 ============
 
+
+.. _install_dep:
+
 Dependencies
 ------------
 
 Dependencies
 ------------
 
@@ -22,6 +25,9 @@ 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.
 
+
+.. _install_pip:
+
 Install Using pip
 -----------------
 
 Install Using pip
 -----------------
 
@@ -34,6 +40,7 @@ LinPy can be installed using pip with the command::
 
     sudo pip install linpy
 
 
     sudo pip install linpy
 
+
 .. _install_source:
 
 Install From Source
 .. _install_source:
 
 Install From Source
index 64c37c61f1ac8e636cecbcb17458c0d88ed0b5d3..ae82aca1a7339986e25d23c3f9742ebd4e26b5ad 100644 (file)
@@ -5,6 +5,8 @@ Module Reference
 ================
 
 
 ================
 
 
+.. _reference_symbols:
+
 Symbols
 -------
 
 Symbols
 -------
 
@@ -70,6 +72,8 @@ This is achieved using ``Dummy('x')``.
     True
 
 
     True
 
 
+.. _reference_linexprs:
+
 Linear Expressions
 ------------------
 
 Linear Expressions
 ------------------
 
@@ -230,6 +234,8 @@ They are implemented by the :class:`Rational` class, that inherits from both :cl
     See the documentation of :class:`fractions.Fraction` for more information and examples.
 
 
     See the documentation of :class:`fractions.Fraction` for more information and examples.
 
 
+.. _reference_polyhedra:
+
 Polyhedra
 ---------
 
 Polyhedra
 ---------
 
@@ -305,6 +311,8 @@ This space can be unbounded.
     The universe polyhedron, whose set of constraints is always satisfiable, i.e. is empty.
 
 
     The universe polyhedron, whose set of constraints is always satisfiable, i.e. is empty.
 
 
+.. _reference_domains:
+
 Domains
 -------
 
 Domains
 -------
 
@@ -487,6 +495,8 @@ Unlike polyhedra, domains allow exact computation of union, subtraction and comp
         Convert the domain to a sympy expression.
 
 
         Convert the domain to a sympy expression.
 
 
+.. _reference_operators:
+
 Comparison and Logic Operators
 ------------------------------
 
 Comparison and Logic Operators
 ------------------------------
 
@@ -532,6 +542,8 @@ The following functions combine :class:`Polyhedron` or :class:`Domain` instances
     Create the complementary domain of the domain given in argument.
 
 
     Create the complementary domain of the domain given in argument.
 
 
+.. _reference_geometry:
+
 Geometric Objects
 -----------------
 
 Geometric Objects
 -----------------
 
index 977b6978b0febc0543fe81cdc8bc1962e45944ec..9b55a03d06d910866a2da0f66aac007184b22d7e 100644 (file)
@@ -5,9 +5,11 @@ Tutorial
 ========
 
 This section a short introduction to some of LinPy's features.
 ========
 
 This section a short introduction to some of LinPy's features.
-For a comprehensive description of its functionalities, please consult the :ref:`reference` section.
+For a comprehensive description of its functionalities, please consult the :ref:`reference`.
 
 
 
 
+.. _tutorial_polyhedra:
+
 Polyhedra
 ---------
 
 Polyhedra
 ---------
 
@@ -57,6 +59,8 @@ True
 False
 
 
 False
 
 
+.. _tutorial_domains:
+
 Domains
 -------
 
 Domains
 -------
 
@@ -79,6 +83,8 @@ Or(And(Eq(x, 0), Ge(y, 0), Ge(-y + 2, 0)), And(Eq(y, 0), Ge(x - 1, 0), Ge(-x + 2
 Or(Ge(-x - 1, 0), Ge(x - 3, 0), And(Ge(x, 0), Ge(-x + 2, 0), Ge(-y - 1, 0)), And(Ge(x, 0), Ge(-x + 2, 0), Ge(y - 3, 0)))
 
 
 Or(Ge(-x - 1, 0), Ge(x - 3, 0), And(Ge(x, 0), Ge(-x + 2, 0), Ge(-y - 1, 0)), And(Ge(x, 0), Ge(-x + 2, 0), Ge(y - 3, 0)))
 
 
+.. _tutorial_plot:
+
 Plotting
 --------
 
 Plotting
 --------