update docs

Author: tomvanmele

docs/conf.py

@@ -48,6 +48,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.githubpages",
     "sphinx.ext.autodoc.typehints",
+    "sphinx_design",
 ]
 
 # autodoc options
@@ -125,6 +126,7 @@ def patched_parse(self):
 intersphinx_mapping = {
     "python": ("https://docs.python.org/", None),
     "compas": ("https://compas.dev/compas/latest/", None),
+    "compas_view2": ("https://compas.dev/compas_view2/latest/", None),
 }
 
 # linkcode

docs/index.rst

@@ -2,12 +2,28 @@
 Documentation of COMPAS CGAL
 ********************************************************************************
 
+.. rst-class:: lead
+
+COMPAS CGAL provides easy-to-use Python bindings for selected algorithms
+of `CGAL, The Computational Geometry Algorithms Library <https://www.cgal.org/>`_.
+
+
+Table of Contents
+=================
+
 .. toctree::
    :maxdepth: 3
    :titlesonly:
 
-   Introduction<self>
+   Introduction <self>
    installation
    examples
    api
    license
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`

docs/installation.rst

@@ -5,7 +5,7 @@ Installation
 Stable
 ======
 
-Stable releases of :mod:`compas_cgal` can be installed via `conda-forge`.
+Stable releases of :mod:`compas_cgal` can be installed via ``conda-forge``.
 
 .. code-block:: bash
 
@@ -33,7 +33,7 @@ Or everything in one go
 Dev Install
 ===========
 
-A local development version can be set up using a combination of `conda` and `pip`.
+A local development version can be set up using a combination of ``conda`` and ``pip``.
 First, clone the :mod:`compas_cgal` repo.
 
 .. code-block:: bash
@@ -100,15 +100,15 @@ Change to the root folder of the :mod:`compas_cgal` repo.
     cd compas_cgal
 
 
-And compile the code while creating an editable install of the python wrapper using `setuptools`.
+And compile the code while creating an editable install of the python wrapper using ``setuptools``.
 
 .. code-block:: bash
 
     pip install -e .
 
 
 To add your c++ module to the wrapper, and potentially exclude some of the existing modules during its development,
-modify the list of extension modules in the `setup.py` file.
+modify the list of extension modules in the ``setup.py`` file.
 
 .. code-block:: python
 

requirements-dev.txt

@@ -13,7 +13,7 @@ m2r
 nbsphinx
 pydocstyle
 pytest >=3.2
-sphinx_compas_theme >=0.15.11
+sphinx_compas_theme >=0.15.13
 sphinx >=3.4
 twine
 wheel