PlasmaPy/.readthedocs.yml at master · dschaffner/PlasmaPy · 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
33
34
35
36
37
38
39
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html

version: 2

sphinx:
  configuration: docs/conf.py

formats:
- htmlzip

build:
  os: ubuntu-24.04
  tools:
    python: '3.12'

  apt_packages:
  - graphviz

  jobs:

    create_environment:
    - asdf plugin add uv
    - asdf install uv latest
    - asdf global uv latest
    - uv venv --python=3.12

    install:
    - uv sync --extra docs --frozen --exact

    build:
      html:
      - uv run --extra docs --frozen --exact nox -s docs

      htmlzip:
      - uv run --extra docs --frozen --exact nox -s docs_bundle_htmlzip

    post_build:
    - echo $'\n'⚠️ For help deciphering documentation build error messages, see:$'\n\n'\ \ https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#troubleshooting