Docs

.gitignore

@@ -70,6 +70,9 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/source/_autosummary/
+docs/source/api/
+docs/source/bin/
 
 # PyBuilder
 .pybuilder/
@@ -158,3 +161,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+docs/source/generated

.readthedocs.yaml

@@ -8,6 +8,13 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
 
 sphinx:
   configuration: docs/source/conf.py
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf

docs/make.bat

@@ -10,6 +10,8 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=source
 set BUILDDIR=build
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -19,17 +21,15 @@ if errorlevel 9009 (
 	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
+	echo.http://sphinx-doc.org/
 	exit /b 1
 )
 
-if "%1" == "" goto help
-
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
 :end
-popd
+popd

docs/requirements.txt

@@ -1,15 +1,14 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
 sphinx-collections
-recommonmark
-piccolo_theme
+sphinx_immaterial
 sphinx_subfigure
 nbsphinx
 myst_parser
 pypandoc
 linkify-it-py
-ipykernel
 omegaconf
 ipywidgets
 ipykernel
 ipython
+pydata-sphinx-theme