Skip to content
Docs

Added DevOps pull-request docs #9

Sign in to view logs

Added DevOps pull-request docs

Added DevOps pull-request docs #9

Workflow file for this run

.github/workflows/docs.yml at 07d2d02
# Copyright © Michal Čihař <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later
name: Docs
on:
push:
branches-ignore:
- deepsource-fix-**
- renovate/**
- weblate
pull_request:
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-22.04
name: Sphinx
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
cache: pip
cache-dependency-path: '**/requirements*.txt'
- name: Install apt dependencies
run: |
sudo apt update
sudo apt install -y graphviz
- name: Install pip dependencies
run: pip install -r docs/requirements.txt
- name: Sphinx build
run: |
echo "::add-matcher::.github/matchers/sphinx.json"
./ci/run-docs
echo "::remove-matcher owner=sphinx::"
- uses: actions/[email protected]
with:
name: Documentation
path: docs/_build/html
linkcheck:
runs-on: ubuntu-22.04
name: Linkcheck
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
cache: pip
cache-dependency-path: '**/requirements*.txt'
- name: Install pip dependencies
run: pip install -r docs/requirements.txt
- name: Sphinx linkcheck
run: |
./ci/run-docs linkcheck
- name: Sphinx linkcheck collect
if: always()
run: |
echo "::add-matcher::.github/matchers/sphinx-linkcheck.json"
echo "::add-matcher::.github/matchers/sphinx-linkcheck-warn.json"
sed 's@^@docs/@' docs/_build/linkcheck/output.txt
echo "::remove-matcher owner=sphinx::"
echo "::remove-matcher owner=sphinx-warn::"
- uses: actions/[email protected]
if: always()
with:
name: Linkcheck report
path: docs/_build/linkcheck/output.txt