Fix docstring of Point.__sub__()

[linpy.git] / doc / index.rst

diff --git a/doc/index.rst b/doc/index.rst
index 0c5738e..a1809d6 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,24 +1,30 @@
-.. 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 <http://isl.gforge.inria.fr/>`_.
+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 <http://www.gnu.org/licenses/gpl-3.0.txt>`_.
+Its source code is available `here <https://scm.cri.ensmp.fr/git/linpy.git>`_.

 
 

-.. toctree::
-   :maxdepth: 2
+To have an overview of LinPy's functionalities, you may wish to consult the :ref:`examples` section.
+
+.. only:: html

 
 

+    Contents:
+
+.. toctree::
+    :maxdepth: 2

 
 

+    install.rst
+    examples.rst
+    reference.rst

 
 

-Indices and tables
-==================
+.. only:: html

 
 

-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    Indices and tables
+    ==================

 
 

+    * :ref:`genindex`
+    * :ref:`search`