add readthedocs config (#110)

barrust · Dec 29, 2023 · 1ba5b01 · 1ba5b01
1 parent fd0f4b0
commit 1ba5b01
Show file tree

Hide file tree

Showing 48 changed files with 29 additions and 5,943 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 sphinx>=3.0
+sphinx-rtd-theme
diff --git a/docs/source/_themes/custom_theme/__init__.py b/docs/source/_themes/custom_theme/__init__.py
diff --git a/docs/source/_themes/custom_theme/breadcrumbs.html b/docs/source/_themes/custom_theme/breadcrumbs.html
diff --git a/docs/source/_themes/custom_theme/footer.html b/docs/source/_themes/custom_theme/footer.html