wpilib-docs/readthedocs.yml at main · wpilibsuite/wpilib-docs · GitHub

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
version: 2

sphinx:
  builder: html
  configuration: source/conf.py
  fail_on_warning: true

python:
   install:
      - method: uv
        command: sync

build:
  os: ubuntu-24.04
  tools:
    python: "3.13"
  apt_packages:
    - librsvg2-bin
  jobs:
    post_checkout:
      - git fetch --unshallow || true
    build:
      htmlzip:
        - mkdir --parents _readthedocs/htmlzip
        # Output to an intermediate directory because RTD doesn't like extra content in the directory. $READTHEDOCS_PROJECT is chosen to so that frc-docs-latest is the root directory of the zip
        - uv run sphinx-build -T -W --keep-going -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=$READTHEDOCS_LANGUAGE source $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT
        - cd $READTHEDOCS_OUTPUT ; zip --recurse-path --symlinks htmlzip/$READTHEDOCS_PROJECT.zip $READTHEDOCS_PROJECT


formats:
  - htmlzip
  - pdf