readthedocs

.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

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"