X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/2baf863a42cd79849834f7d8ad4d4f428929e3d1..7fda4e3865bb7cc9b6ee15cfd3c62c207f585ec7:/doc/index.rst diff --git a/doc/index.rst b/doc/index.rst index b3a9271..a1809d6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,25 +1,30 @@ -.. LinPy documentation master file, created by - sphinx-quickstart on Wed Jun 25 20:34:21 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. Welcome to LinPy’s documentation! ================================= -LinPy is a Python wrapper for the Integer Set Library (isl) by Sven Verdoolaege. Isl ia a C library for manipulating sets and relations of integer points bounded by linear constraints. +LinPy is a polyhedral library for Python based on `isl `_. +Integer Set Library (isl) is a C library for manipulating sets and relations of integer points bounded by linear constraints. -If you are new to LinPy, start with the Examples. +LinPy is a free software, licensed under the `GPLv3 license `_. +Its source code is available `here `_. -This is the central page for all of LinPy’s documentation. +To have an overview of LinPy's functionalities, you may wish to consult the :ref:`examples` section. -Contents: +.. only:: html + + Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - install.rst - examples.rst - modules.rst + install.rst + examples.rst + reference.rst +.. only:: html + Indices and tables + ================== + * :ref:`genindex` + * :ref:`search`