Merge pull request #35 from meom-group/rtd

Rtd
meom-group · Nov 10, 2023 · fc26700 · fc26700
2 parents 2a109f1 + 438ae06
commit fc26700
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 35 deletions.
diff --git a/.github/workflows/python-documentation.yml b/.github/workflows/python-documentation.yml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  builder: html
+
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,7 +38,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 html_js_files = [
     "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
 ]

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx
+myst_parser
+sphinx-rtd-theme