docs: Read the Docs configuration (#1)

Quantco · Aug 13, 2024 · 3908bb9 · 3908bb9
1 parent c56eab9
commit 3908bb9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,14 @@
+version: 2
+build:
+  os: ubuntu-20.04
+  tools:
+    python: mambaforge-latest
+  commands:
+    - mamba install -c conda-forge -c nodefaults pixi
+    - pixi run -e docs postinstall
+    - pixi run -e docs docs
+    - pixi run -e docs readthedocs
+sphinx:
+  configuration: docs/conf.py
+formats:
+  - pdf
diff --git a/pixi.toml b/pixi.toml
@@ -37,6 +37,7 @@ sphinx_rtd_theme = "*"
 sphinxcontrib-apidoc = "*"
 [feature.docs.tasks]
 docs = "cd docs && make html"
+readthedocs = "rm -rf $READTHEDOCS_OUTPUT/html && cp -r docs/_build/html $READTHEDOCS_OUTPUT/html"
 
 [feature.test.dependencies]
 mypy = "*"