updated for read the docs

ElPsyKurisu · Nov 19, 2024 · 9b1f628 · 9b1f628
1 parent 2dc3409
commit 9b1f628
Show file tree

Hide file tree

Showing 30 changed files with 170 additions and 555 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,20 +1,14 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: "2"
 
-# Required
-version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
 
-sphinx:
-    configuration: docs/source/conf.py
-    fail_on_warning: false
-
-formats: all
-
-# Optionally set the version of Python and requirements required to build your docs
 python:
-   version: "3.8"
-   install:
-   - requirements: docreqs.txt
+  install:
+    - requirements: docs/requirements.txt
 
+sphinx:
+  configuration: docs/source/conf.py
 
diff --git a/docreqs.txt b/docreqs.txt
@@ -3,4 +3,6 @@ numpy>=1.19.2
 matplotlib>=3.3.4
 scipy>=1.6.2
 pyvisa>=1.11.3
-IPython>=7.22.0
+IPython>=7.22.0
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
diff --git a/docs/source/ekpy.analysis.FE_switching.rst b/docs/source/ekpy.analysis.FE_switching.rst
diff --git a/docs/source/ekpy.analysis.asylum.rst b/docs/source/ekpy.analysis.asylum.rst
diff --git a/docs/source/ekpy.analysis.ppms.rst b/docs/source/ekpy.analysis.ppms.rst
diff --git a/docs/source/ekpy.analysis.radiant.rst b/docs/source/ekpy.analysis.radiant.rst
diff --git a/docs/source/ekpy.analysis.rst b/docs/source/ekpy.analysis.rst
diff --git a/docs/source/ekpy.control.instruments.SI5580.rst b/docs/source/ekpy.control.instruments.SI5580.rst
diff --git a/docs/source/ekpy.control.instruments.berkeleynucleonics765.rst b/docs/source/ekpy.control.instruments.berkeleynucleonics765.rst
diff --git a/docs/source/ekpy.control.instruments.keithley2400.rst b/docs/source/ekpy.control.instruments.keithley2400.rst
diff --git a/docs/source/ekpy.control.instruments.keithley6221.rst b/docs/source/ekpy.control.instruments.keithley6221.rst
diff --git a/docs/source/ekpy.control.instruments.lakeshore475.rst b/docs/source/ekpy.control.instruments.lakeshore475.rst
diff --git a/docs/source/ekpy.control.instruments.lakeshore647.rst b/docs/source/ekpy.control.instruments.lakeshore647.rst
diff --git a/docs/source/ekpy.control.instruments.misc.rst b/docs/source/ekpy.control.instruments.misc.rst
diff --git a/docs/source/ekpy.control.instruments.rst b/docs/source/ekpy.control.instruments.rst