summaryrefslogtreecommitdiffstats
path: root/.readthedocs.yaml
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2023-02-25 01:45:39 +0100
committerThomas Waldmann <tw@waldmann-edv.de>2023-02-25 02:16:21 +0100
commita40390b1ac2eda60f0df042949b04a8d3aaa2bdf (patch)
treebc344e23d73ee01186f94425ff766a9ef56b773b /.readthedocs.yaml
parentb208785fff053ea6c2e6ccfd0ffe65df7b4f5782 (diff)
add .readthedocs.yaml
otherwise rtd uses: - python 3.7, which is too old for borg. - shallow git checkout, which might make setuptools_scm fail to create a correct version
Diffstat (limited to '.readthedocs.yaml')
-rw-r--r--.readthedocs.yaml33
1 files changed, 33 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000..986fce3de
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,33 @@
+# .readthedocs.yaml - Read the Docs configuration file.
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details.
+
+version: 2
+
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.11"
+ jobs:
+ post_checkout:
+ - git fetch --unshallow
+ apt_packages:
+ - build-essential
+ - pkg-config
+ - libacl1-dev
+ - libssl-dev
+ - liblz4-dev
+ - libzstd-dev
+ - libxxhash-dev
+
+python:
+ install:
+ - requirements: requirements.d/development.lock.txt
+ - requirements: requirements.d/docs.txt
+ - method: pip
+ path: .
+
+sphinx:
+ configuration: docs/conf.py
+
+formats:
+ - pdf