ansible-builder/.readthedocs.yaml at devel · ansible/ansible-builder · 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
---

version: 2

build:
  os: ubuntu-24.04
  tools:
    python: >-  # has to be parsed as a YAML string
      3.13
  commands:
  - >-
    PYTHONWARNINGS=error
    python3 -Im venv "${READTHEDOCS_VIRTUALENV_PATH}"
  - >-
    PYTHONWARNINGS=error
    "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
    pip install tox
  - >-
    PYTHONWARNINGS=error
    "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
    tox -e build-docs --notest -vvvvv
  - >-
    PYTHONWARNINGS=error
    "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
    tox -e build-docs --skip-pkg-install -q
    --
    -D language="${READTHEDOCS_LANGUAGE}"
    "${READTHEDOCS_OUTPUT}"/html -b dirhtml
  - >-
    PYTHONWARNINGS=error
    "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
    tox -e build-docs --skip-pkg-install -q
    --
    -D language="${READTHEDOCS_LANGUAGE}"
    "${READTHEDOCS_OUTPUT}"/pdf -b latex
  - cat "${READTHEDOCS_OUTPUT}"/pdf/latexmkrc
  - >-  # https://mg.rtfd.io/latexmk.html is a Perl script pre-installed on RTD
    cd "${READTHEDOCS_OUTPUT}"/pdf/
    &&
    latexmk -r latexmkrc
    -pdf -f -dvi- -ps-
    -jobname="${READTHEDOCS_PROJECT}"
    -interaction=nonstopmode
  - >-  # RTD requires only a single PDF file to be in the output directory
    find "${READTHEDOCS_OUTPUT}"/pdf
    -type f
    -not -name "${READTHEDOCS_PROJECT}.pdf"
    -delete
    &&
    find "${READTHEDOCS_OUTPUT}"/pdf
    -mindepth 1
    -type d
    -delete
    && ls -1 "${READTHEDOCS_OUTPUT}"/pdf
  - >-
    PYTHONWARNINGS=error
    "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
    tox -e build-docs --skip-pkg-install -q
    --
    -D language="${READTHEDOCS_LANGUAGE}"
    "${READTHEDOCS_OUTPUT}"/epub -b epub
  - >-  # RTD requires only a single epub file to be in the output directory
    find "${READTHEDOCS_OUTPUT}"/epub
    -type f
    -not -name "${READTHEDOCS_PROJECT}.epub"
    -delete
    &&
    find "${READTHEDOCS_OUTPUT}"/epub
    -mindepth 1
    -type d
    -delete
    && ls -1 "${READTHEDOCS_OUTPUT}"/epub

...