fix documentation issues with readthedocs

choosehappy · May 29, 2024 · 0396949 · 0396949
1 parent be517e4
commit 0396949
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 24 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,6 +8,8 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
+    - method: pip
+      path: .
 
 sphinx:
   configuration: docs/source/conf.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -9,7 +9,7 @@
 project = 'HoverFast'
 copyright = '2024, Petros Liakopoulos, Julien Massonnet, Andrew Janowczyk'
 author = 'Petros Liakopoulos, Julien Massonnet, Andrew Janowczyk'
-release = '1.0'
+release = '1.0.0'
 version = '1.0.0'
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -29,6 +29,7 @@ For that reason, we highly recommend looking into other tools such as HistoQC (h
 
 
 .. toctree::
+   :maxdepth: 3
    :caption: Contents:
 
    installation

diff --git a/docs/source/infer_roi.rst b/docs/source/infer_roi.rst
@@ -134,8 +134,9 @@ Functions
 
 The `infer_roi` module contains the following functions:
 
+.. dropdown:: Click to show/hide functions
 
-.. automodule:: hoverfast.utils_roi
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    .. automodule:: hoverfast.utils_roi
+        :members:
+        :undoc-members:
+        :show-inheritance:
diff --git a/docs/source/infer_wsi.rst b/docs/source/infer_wsi.rst
@@ -168,8 +168,9 @@ Functions
 
 The `infer_wsi` module contains the following functions:
 
+.. dropdown:: Click to show/hide functions
 
-.. automodule:: hoverfast.utils_wsi
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    .. automodule:: hoverfast.utils_wsi
+        :members:
+        :undoc-members:
+        :show-inheritance:
diff --git a/docs/source/training.rst b/docs/source/training.rst
@@ -194,23 +194,23 @@ Functions
 
 The `train` module contains the following functions:
 
+.. dropdown:: Click to show/hide functions
 
+    .. automodule:: hoverfast.training_utils
+        :members:
+        :undoc-members:
+        :show-inheritance:
 
-.. automodule:: hoverfast.training_utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. dropdown:: Click to show/hide functions
 
+    .. automodule:: hoverfast.augment
+        :members:
+        :undoc-members:
+        :show-inheritance:
 
+.. dropdown:: Click to show/hide functions
 
-.. automodule:: hoverfast.augment
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-
-.. automodule:: hoverfast.hoverfast
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    .. automodule:: hoverfast.hoverfast
+        :members:
+        :undoc-members:
+        :show-inheritance: