From 7bac48e1d6a84020aa85c20955807c2536f1ebd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Mon, 16 Oct 2023 18:48:01 -0400 Subject: [PATCH] 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. --- .readthedocs.yaml | 3 +++ doc/index.rst | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2f6d2d0..d08145e 100644 --- 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 index c3af5e2..7df3fe3 100644 --- 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