Merge branch 'develop'

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
 <<<<<<<<<<<<<<<<<<<<<<<<<
 

docs/source/api.rst

@@ -4,10 +4,9 @@ API Documentation
 
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
 
     api_files/dataset
-    autoapi/summit/multiview_platform/monoview_classifiers/index
-    autoapi/summit/multiview_platform/multiview_classifiers/index
+
 
 

docs/source/api_files/dataset.rst

-Multiview dataset management module
------------------------------------
+Multiview dataset management
+----------------------------
 
 .. automodule:: summit.multiview_platform.utils.dataset
    :members:

docs/source/classifiers.rst

+.. toctree::
+    :maxdepth: 1
+
+    autoapi/summit/multiview_platform/monoview_classifiers/index
+    autoapi/summit/multiview_platform/multiview_classifiers/index
\ No newline at end of file

docs/source/index.rst

@@ -15,11 +15,12 @@ This documentation consists in a short read me, with instructions to install and
    :maxdepth: 2
 
    tutorials/index
+   api
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
-   api
+   classifiers
 
 
 Read me