readthedocs

Author: taehyounpark

.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.12"
+    # 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

docs/requirements.txt

@@ -0,0 +1,7 @@
+sphinx>=6.2.1
+pydata-sphinx-theme>=0.15.2
+myst-parser
+sphinx-sitemap
+sphinx-design
+linkify-it-py
+breathe

docs/things

@@ -0,0 +1,7 @@
+pip install sphinx
+pip install sphinx-sitemap
+pip install pydata-sphinx-theme
+pip install sphinx-design
+pip install myst-parser
+pip install linkify-it-py
+pip install breathe