X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/3ed20034d218d5d5245353b8de566b5c27dcc727..a13b139496c50e81964197336f51303022ab4e3b:/doc/index.rst diff --git a/doc/index.rst b/doc/index.rst index 0c5738e..ce346f1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,24 +1,32 @@ -.. pypol 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 pypol's documentation! +Welcome to LinPy’s documentation! ================================= -Since Pythagoras, we know that :math:`c = \sqrt{a^2 + b^2}`. +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. -Contents: +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 read the :ref:`tutorial`. +For a comprehensive description of its functionalities, please consult the :ref:`reference`. + +.. only:: html + + Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 2 + install.rst + tutorial.rst + reference.rst -Indices and tables -================== +.. only:: html -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Indices and tables + ================== + * :ref:`genindex` + * :ref:`search`