readthedocs.yaml

Read the Docs configuration file used to build this docs:

.readthedocs.yaml
 1version: 2
 2
 3build:
 4  os: ubuntu-24.04
 5  tools:
 6    python: "latest"
 7    nodejs: "latest"
 8    golang: "latest"
 9    rust: "latest"
10    ruby: "latest"
11  apt_packages:
12    - tree
13    - libasound2t64
14    - jq
15  jobs:
16    post_checkout:
17     # Test we can use a PUBLIC environment variable in a command
18     - echo ${PUBLIC}
19
20    pre_install:
21      - curl 'http://devthedocs.org/api/v2/project/?slug=test-builds-disable-sphinx-manipulation' | jq
22      - curl 'http://web:8000/api/v2/project/?slug=test-builds-disable-sphinx-manipulation' | jq
23      - curl 'http://$READTHEDOCS_HOSTIP/api/v2/project/?slug=test-builds-disable-sphinx-manipulation' | jq
24      - curl 'http://$READTHEDOCS_HOSTIP/api/v2/version/?project__slug=test-builds-disable-sphinx-manipulation&active=true' | jq
25
26    post_install:
27      # Test jsdoc
28      - npm install -g jsdoc
29
30    pre_build:
31      - shot-scraper install
32      - shot-scraper https://datasette.io/ --height 800 -o docs/static/datasette.png
33
34    post_build:
35      # Download a PDF sample and expose it
36      - mkdir -p $READTHEDOCS_OUTPUT/pdf/
37      - wget https://pdfobject.com/pdf/sample.pdf -O $READTHEDOCS_OUTPUT/pdf/my-file.pdf
38
39
40sphinx:
41  configuration: docs/conf.py
42
43python:
44  install:
45    - requirements: requirements.txt