icalendar/.readthedocs.yml at main · collective/icalendar · 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
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

build:
  os: ubuntu-22.04
  tools:
    python: "3.13"
  commands:
    # Cancel building pull requests when there aren't changes in the docs directory or YAML file.
    # You can add any other files or directories that you'd like here as well,
    # like your docs requirements file, or other files that will change your docs build.
    #
    # If there are no changes (git diff exits with 0) we force the command to return with 183.
    # This is a special exit code on Read the Docs that will cancel the build immediately.
    - |
      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- . docs/ \
        src/icalendar/**/*.py \
        .github/workflows/documentation.yml \
        .github/workflows/rtd-pr-preview.yml \
        .readthedocs.yml \
        .vale.ini \
        CHANGES.rst \
        Makefile \
        pyproject.toml \
        ':!src/icalendar/fuzzing' \
        ':!src/icalendar/tests' \
        ':!src/icalendar/timezone';
      then
        exit 183;
      fi
    - git fetch --tags || true
    - make rtd-pr-preview