Added compose example #28
This file contains 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
name: ci-docs | |
on: | |
push: | |
branches: | |
- master | |
paths: | |
- "docs/**" | |
- "pyproject.toml" | |
- ".github/workflows/ci-docs.yml" | |
pull_request: | |
branches-ignore: [gh-pages] | |
paths: | |
- "docs/**" | |
- "pyproject.toml" | |
- ".github/workflows/ci-docs.yml" | |
workflow_dispatch: | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
timeout-minutes: 30 | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Cache Python dependencies | |
uses: actions/cache@v3 | |
with: | |
path: ~/.cache/pip | |
key: pip-3.10-docs-${{ hashFiles('**/pyproject.toml') }} | |
restore-keys: pip-3.10 | |
- name: Set up Python 3.10 | |
uses: actions/setup-python@v3 | |
with: | |
python-version: '3.10' | |
- name: Install python dependencies | |
run: | | |
pip install --upgrade pip | |
pip install -e .[docs] | |
- name: Build HTML docs | |
id: linkcheck | |
run: | | |
make -C docs html linkcheck 2>&1 | tee check.log | |
echo "broken=$(grep -E 'line\s+[0-9]+)\s+broken\s+' check.log)" >> $GITHUB_OUTPUT | |
env: | |
SPHINXOPTS: -nW --keep-going | |
- name: Show docs build check results | |
run: | | |
if [ -z "${{ steps.linkcheck.outputs.broken }}" ]; then | |
echo "No broken links found." | |
exit 0 | |
else | |
echo "Broken links found:" | |
echo "${{ steps.linkcheck.outputs.broken }}" | |
exit 1 | |
fi |