icalendar/.github/workflows/documentation.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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
name: Build documentation, check links, spelling, grammar, and style
on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
  # Build pull requests
  pull_request:
    paths:
      - 'docs/**'
      - 'Makefile'
      - 'src/icalendar/*.py'
      - 'src/icalendar/cal/*.py'
      - 'src/icalendar/prop/*.py'
      - 'src/icalendar/timezone/*.py'
      - 'styles/**'
      - '.github/workflows/rtd-pr-preview.yml'
      - '.github/workflows/documentation.yml'
      - '.readthedocs.yaml'
      - '.vale.ini'
      - 'uv.lock'

jobs:
  docs:
    name: Documentation
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.11', '3.14']
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          fetch-tags: true

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          # Install a specific version of uv.
          version: "0.9.3"

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}

      - name: Create Python virtual environment, install requirements
        run: make .venv PYTHONVERSION=${{ matrix.python-version }}

      - name: Build HTML documentation
        run: make html PYTHONVERSION=${{ matrix.python-version }}

      - name: Run vale
        run: make vale VALEOPTS="--minAlertLevel='warning'" PYTHONVERSION=${{ matrix.python-version }}

      - name: Check for broken links
        run: make linkcheckbroken PYTHONVERSION=${{ matrix.python-version }}