From a13b139496c50e81964197336f51303022ab4e3b Mon Sep 17 00:00:00 2001 From: Vivien Maisonneuve Date: Wed, 20 Aug 2014 10:14:18 +0200 Subject: [PATCH] Add labels to documentation sections --- doc/index.rst | 5 +++-- doc/install.rst | 7 +++++++ doc/reference.rst | 12 ++++++++++++ doc/tutorial.rst | 8 +++++++- 4 files changed, 29 insertions(+), 3 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index fee1edf..ce346f1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_. Its source code is available `here `_. -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 @@ -22,6 +22,7 @@ For a comprehensive description of its functionalities, see the :ref:`reference` tutorial.rst reference.rst + .. only:: html Indices and tables diff --git a/doc/install.rst b/doc/install.rst index f5c1c9e..2d7883b 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -4,6 +4,9 @@ Installation ============ + +.. _install_dep: + 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 `_ and `matplotlib `_. Please consult the `SymPy download page `_ and `matplotlib installation instructions `_ to install these libraries. + +.. _install_pip: + Install Using pip ----------------- @@ -34,6 +40,7 @@ LinPy can be installed using pip with the command:: sudo pip install linpy + .. _install_source: Install From Source diff --git a/doc/reference.rst b/doc/reference.rst index 64c37c6..ae82aca 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -5,6 +5,8 @@ Module Reference ================ +.. _reference_symbols: + Symbols ------- @@ -70,6 +72,8 @@ This is achieved using ``Dummy('x')``. True +.. _reference_linexprs: + 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. +.. _reference_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. +.. _reference_domains: + Domains ------- @@ -487,6 +495,8 @@ Unlike polyhedra, domains allow exact computation of union, subtraction and comp Convert the domain to a sympy expression. +.. _reference_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. +.. _reference_geometry: + Geometric Objects ----------------- diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 977b697..9b55a03 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -5,9 +5,11 @@ Tutorial ======== 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 --------- @@ -57,6 +59,8 @@ True False +.. _tutorial_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))) +.. _tutorial_plot: + Plotting -------- -- 2.20.1