From a4331f5c56cc839814e6f15194336e2bb7b8f44e Mon Sep 17 00:00:00 2001
From: Baptiste Bauvin <baptiste.bauvin@lis-lab.fr>
Date: Fri, 1 May 2020 14:16:45 -0400
Subject: [PATCH] Toctree organization
---
docs/source/api.rst | 5 ++---
docs/source/api_files/dataset.rst | 4 ++--
docs/source/classifiers.rst | 5 +++++
docs/source/index.rst | 5 +++--
4 files changed, 12 insertions(+), 7 deletions(-)
create mode 100644 docs/source/classifiers.rst
diff --git a/docs/source/api.rst b/docs/source/api.rst
index 185c395b..3d362769 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 a41cca08..72b8f4ad 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 00000000..f14e5f96
--- /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 285ab422..97c2a905 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
--
GitLab