diff --git a/README.rst b/README.rst index 650b3a2c3618d29c306073533f51f15446307a8c..ae56f162e10417d9b9f3aa4cd8eb932cc2463e89 100644 --- a/README.rst +++ b/README.rst @@ -78,10 +78,24 @@ To run the test suite of SuMMIT, run : .. code:: bash cd path/to/summit + pip install -e .[dev] pytest The coverage report is automatically generated and stored in the ``htmlcov/`` directory +Building the documentation +<<<<<<<<<<<<<<<<<<<<<<<<<< + +To locally build the `documentation <http://baptiste.bauvin.pages.lis-lab.fr/summit/index.html>`_ run : + +.. code:: bash + + cd path/to/summit + pip install -e .[doc] + python setup.py build_sphinx + +The built html files will be stored in ``path/to/summit/build/sphinx/html`` + Running on simulated data <<<<<<<<<<<<<<<<<<<<<<<<<