feat(docs): Add Read-The-Docs Support

TheOnlyWayUp · Feb 2, 2024 · b5c83e4 · b5c83e4
1 parent 063cbe9
commit b5c83e4
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+  - requirements: docs_requirements.txt
diff --git a/docs_requirements.txt b/docs_requirements.txt
@@ -0,0 +1,7 @@
+mkdocs==1.5.3
+mkdocs-autorefs==0.5.0
+mkdocs-jupyter==0.24.6
+mkdocs-material==9.5.5
+mkdocs-material-extensions==1.3.1
+mkdocstrings==0.24.0
+mkdocstrings-python==1.8.0