Skip to content

docs: clarify new() docstrings of Alarm, Availability, Available and Todo #2707

docs: clarify new() docstrings of Alarm, Availability, Available and Todo

docs: clarify new() docstrings of Alarm, Availability, Available and Todo #2707

Workflow file for this run

name: Check news fragments filenames, 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/documentation.yml'
- '.readthedocs.yaml'
- '.vale.ini'
- 'uv.lock'
- 'news/*.*'
jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.11', '3.14']
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
fetch-depth: 0
fetch-tags: true
- name: Install uv
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
# Install a specific version of uv.
version: "0.9.3"
- name: Create Python virtual environment, install requirements
run: make .venv PYTHONVERSION=${{ matrix.python-version }}
- name: Check news fragments filenames
run: make changes-check 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 }}