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 <<<<<<<<<<<<<<<<<<<<<<<<< diff --git a/docs/source/api.rst b/docs/source/api.rst index 185c395b5f3dbe5288d495b113ad73a5d98ca374..3d362769c83c5e7d3fff1f460aa3b7dbd29070ce 100644 --- a/docs/source/api.rst +++ b/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 + diff --git a/docs/source/api_files/dataset.rst b/docs/source/api_files/dataset.rst index a41cca087bfe81079182d4f74b0e9384e793e978..72b8f4ad1e6f6b6831d5d500f61589739c6b7cac 100644 --- a/docs/source/api_files/dataset.rst +++ b/docs/source/api_files/dataset.rst @@ -1,5 +1,5 @@ -Multiview dataset management module ------------------------------------ +Multiview dataset management +---------------------------- .. automodule:: summit.multiview_platform.utils.dataset :members: diff --git a/docs/source/classifiers.rst b/docs/source/classifiers.rst new file mode 100644 index 0000000000000000000000000000000000000000..f14e5f968a17a2a7409418a6eb8642223b95ef34 --- /dev/null +++ b/docs/source/classifiers.rst @@ -0,0 +1,5 @@ +.. toctree:: + :maxdepth: 1 + + autoapi/summit/multiview_platform/monoview_classifiers/index + autoapi/summit/multiview_platform/multiview_classifiers/index \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 285ab422dfb4fb7ec285e0e5a42621cc24ab3963..97c2a905eefc85d6343ec6580cdceb643da9ae0d 100644 --- a/docs/source/index.rst +++ b/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