mkdocs for readthedocs

Author: raylu

.readthedocs.yaml

@@ -1,14 +1,17 @@
-# https://docs.readthedocs.io/en/stable/config-file/v2.html
+# https://docs.readthedocs.com/platform/stable/intro/mkdocs.html
 
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3"
+  jobs:
+    pre_install:
+      - pip install --progress-bar off 'mkdocstrings[python]' 'mkdocs-material[imaging]' 'git+https://github.com/mkdocstrings/griffe'
 
-sphinx:
-  configuration: docs/conf.py
+mkdocs:
+  configuration: mkdocs.yml
 
 # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:

mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: pigwig
-site_url: https://raylu.github.io/pigwig
+site_url: !ENV READTHEDOCS_CANONICAL_URL
 repo_url: https://github.com/raylu/pigwig
 edit_uri: edit/main/docs/
 plugins: