ENH: Fix modules in index.rst Sphinx documentation index file

Fix the package and script module names in the `index.rst` Sphinx documentation index file so that they can be correctly discovered. Allows the documentation to be extracted successfully by Sphinx.
scil-vital · Oct 17, 2023 · 7bac48e · 7bac48e
1 parent 548392e
commit 7bac48e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,6 +13,9 @@ build:
   apt_packages:
     - libblas-dev
     - liblapack-dev
+  jobs:
+    pre_build:
+      - sphinx-apidoc -f -o . ../
 
 # Build documentation in the doc/ directory with Sphinx
 sphinx:

diff --git a/doc/index.rst b/doc/index.rst
@@ -4,5 +4,5 @@ Welcome to the tractolearn documentation!
 .. toctree::
     :maxdepth: 1
 
-    modules/tractolearn
-    scripts/modules
+    modules
+    scripts