Documentation #84
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright © Michal Čihař <michal@weblate.org> | |
| # | |
| # SPDX-License-Identifier: GPL-3.0-or-later | |
| name: Documentation | |
| on: | |
| push: | |
| branches-ignore: | |
| - renovate/** | |
| - weblate | |
| pull_request: | |
| schedule: | |
| - cron: 30 5 * * * | |
| permissions: | |
| contents: read | |
| jobs: | |
| list-languages: | |
| runs-on: ubuntu-24.04 | |
| outputs: | |
| languages: ${{ steps.list.outputs.languages }} | |
| steps: | |
| - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| with: | |
| persist-credentials: false | |
| - uses: astral-sh/setup-uv@557e51de59eb14aaaba2ed9621916900a91d50c6 # v6.6.1 | |
| - name: Set up Python | |
| uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 | |
| with: | |
| python-version: '3.13' | |
| - run: uv run --no-project scripts/list-documentation-languages.py >>"$GITHUB_OUTPUT" | |
| id: list | |
| translations: | |
| runs-on: ubuntu-24.04 | |
| needs: | |
| - list-languages | |
| name: Sphinx | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| language: ${{ fromJson(needs.list-languages.outputs.languages) }} | |
| env: | |
| READTHEDOCS_LANGUAGE: ${{ matrix.language }} | |
| steps: | |
| - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| with: | |
| persist-credentials: false | |
| - uses: astral-sh/setup-uv@557e51de59eb14aaaba2ed9621916900a91d50c6 # v6.6.1 | |
| - name: Set up Python | |
| uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install apt dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y graphviz | |
| - name: Install Python dependencies | |
| run: uv sync --only-group docs --frozen | |
| - name: Sphinx build | |
| run: | | |
| . .venv/bin/activate | |
| echo "::add-matcher::.github/matchers/sphinx.json" | |
| ./ci/run-docs | |
| echo "::remove-matcher owner=sphinx::" | |
| - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 | |
| with: | |
| name: Documentation ${{ matrix.language }} | |
| path: docs/_build/html | |
| build: | |
| runs-on: ubuntu-24.04 | |
| name: Sphinx | |
| needs: | |
| - translations | |
| steps: | |
| # This is dependency only job to collect all test results | |
| - run: echo |