From 2f22a410a52b134f0130f46fbb437cb5113c4b3e Mon Sep 17 00:00:00 2001
From: stone_tao <stonezt2019@gmail.com>
Date: Sat, 2 Mar 2024 13:43:55 -0800
Subject: [PATCH] readthedocs

---
 .readthedocs.yaml     | 32 ++++++++++++++++++++++++++++++++
 docs/requirements.txt | 12 ++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 docs/requirements.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000..5c7ee3a49
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,32 @@
+# .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 OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 000000000..a552ff190
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,12 @@
+"sphinx==6.2.1",
+"sphinx-autobuild"
+"sphinx-book-theme"
+# For spelling
+"sphinxcontrib.spelling"
+# Type hints support
+"sphinx-autodoc-typehints"
+# Copy button for code snippets
+"sphinx_copybutton"
+# Markdown parser
+"myst-parser"
+"sphinx-subfigure"
\ No newline at end of file