From d327c4ac534779c6c786a4dfb3107053e6069d23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Tue, 17 Oct 2023 16:08:37 -0400 Subject: [PATCH] DOC: Fix Sphinx documentation Fix Sphinx documentation. --- .readthedocs.yaml | 3 +++ doc/Makefile | 2 +- doc/conf.py | 1 + doc/index.rst | 4 ++-- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2f6d2d05..e8b53c57 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 doc . # Build documentation in the doc/ directory with Sphinx sphinx: diff --git a/doc/Makefile b/doc/Makefile index 26217e7e..d0c3cbf1 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = doc +SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". diff --git a/doc/conf.py b/doc/conf.py index d74a0545..ef585716 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -67,6 +67,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.napoleon", ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/index.rst b/doc/index.rst index 201b2763..4531c8d4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,6 +3,6 @@ Welcome to the whitematteranalysis documentation! .. toctree:: :maxdepth: 1 + :caption: Reference - bin - utilities + modules