aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.readthedocs.yaml20
1 files changed, 20 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..da04b12
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+version: 2
+
+build:
+ os: "ubuntu-22.04"
+ tools:
+ python: "3.12"
+ jobs:
+ post_create_environment:
+ # Install poetry
+ # https://python-poetry.org/docs/#installing-manually
+ - pip install poetry
+ post_install:
+ # Install dependencies with 'docs' dependency group
+ # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
+ # VIRTUAL_ENV needs to be set manually for now.
+ # See https://github.com/readthedocs/readthedocs.org/pull/11152/
+ - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+
+mkdocs:
+ configuration: docs/mkdocs.yml