From 889eb0a64598c3a28a15e37b1d58eaae27d063dd Mon Sep 17 00:00:00 2001
From: jason810496 <810496@email.wlsh.tyc.edu.tw>
Date: Mon, 15 Jul 2024 22:21:41 +0800
Subject: [PATCH] doc: add

---
 .readthedocs.yml     | 35 +++++++++++++++++++++++++++++++++++
 doc/requirements.txt |  4 ++++
 2 files changed, 39 insertions(+)
 create mode 100644 .readthedocs.yml
 create mode 100644 doc/requirements.txt

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 0000000..18117b9
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# 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.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  fail_on_warning: true
+
+# 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/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..d997ada
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,4 @@
+sphinx
+sphinx-autobuild
+sphinx-rtd-theme
+sphinx-copybutton
\ No newline at end of file