add readthedocs YAML config

Author: belm0

.readthedocs.yaml

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

docs/conf.py

@@ -12,9 +12,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------

docs/requirements.in

@@ -0,0 +1,4 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-trio
+trio

docs/requirements.txt

@@ -0,0 +1,82 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    pip-compile --output-file=requirements.txt requirements.in
+#
+alabaster==0.7.13
+    # via sphinx
+attrs==25.1.0
+    # via
+    #   outcome
+    #   trio
+babel==2.17.0
+    # via sphinx
+certifi==2025.1.31
+    # via requests
+charset-normalizer==3.4.1
+    # via requests
+docutils==0.20.1
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+exceptiongroup==1.2.2
+    # via trio
+idna==3.10
+    # via
+    #   requests
+    #   trio
+imagesize==1.4.1
+    # via sphinx
+importlib-metadata==8.5.0
+    # via sphinx
+jinja2==3.1.5
+    # via sphinx
+markupsafe==2.1.5
+    # via jinja2
+outcome==1.3.0.post0
+    # via trio
+packaging==24.2
+    # via sphinx
+pygments==2.19.1
+    # via sphinx
+pytz==2025.1
+    # via babel
+requests==2.32.3
+    # via sphinx
+sniffio==1.3.1
+    # via trio
+snowballstemmer==2.2.0
+    # via sphinx
+sortedcontainers==2.4.0
+    # via trio
+sphinx==7.1.2
+    # via
+    #   -r requirements.in
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-jquery
+    #   sphinxcontrib-trio
+sphinx-rtd-theme==3.0.2
+    # via -r requirements.in
+sphinxcontrib-applehelp==1.0.4
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.1
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+sphinxcontrib-trio==1.1.2
+    # via -r requirements.in
+trio==0.27.0
+    # via -r requirements.in
+urllib3==2.2.3
+    # via requests
+zipp==3.20.2
+    # via importlib-metadata