readthedocs.yaml

Read the Docs configuration file used to build this docs:

.readthedocs.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
version: 2

build:
  os: ubuntu-24.04
  tools:
    python: "latest"
    nodejs: "latest"
    golang: "latest"
    rust: "latest"
    ruby: "latest"
  apt_packages:
    - tree
    - libasound2t64
  jobs:
    post_checkout:
     # Test we can use a PUBLIC environment variable in a command
     - echo ${PUBLIC}

    post_install:
      # Test jsdoc
      - npm install -g jsdoc

    pre_build:
      - shot-scraper install
      - shot-scraper https://datasette.io/ --height 800 -o docs/static/datasette.png

    post_build:
      # Download a PDF sample and expose it
      - mkdir -p $READTHEDOCS_OUTPUT/pdf/
      - wget https://pdfobject.com/pdf/sample.pdf -O $READTHEDOCS_OUTPUT/pdf/my-file.pdf


sphinx:
  configuration: docs/conf.py

python:
  install:
    - requirements: requirements.txt