Ignore Sphinx errors on master builds #1097
Workflow file for this run
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
# SPDX-FileCopyrightText: Copyright DB InfraGO AG | ||
# SPDX-License-Identifier: CC0-1.0 | ||
name: Docs | ||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: [master] | ||
pull_request: | ||
jobs: | ||
sphinx: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- uses: actions/setup-python@v5 | ||
with: | ||
cache: pip | ||
cache-dependency-path: pyproject.toml | ||
python-version: "3.12" | ||
- name: Upgrade pip | ||
run: python -m pip install -U pip | ||
- name: Install dependencies | ||
run: | | ||
sudo apt-get install -y pandoc | ||
python -m pip install '.[docs]' | ||
- name: Auto-generate APIDOC sources | ||
run: make -C docs apidoc | ||
- name: Create docs | ||
env: | ||
SPHINXOPTS: ${{ github.ref != 'refs/heads/master' && "-W" || "" }} | ||
Check failure on line 36 in .github/workflows/docs.yml GitHub Actions / DocsInvalid workflow file
|
||
run: make -C docs html | ||
- name: Upload built docs as artifact | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: Documentation | ||
path: docs/build/html | ||
if-no-files-found: error | ||
retention-days: 5 | ||
- name: Deploy | ||
if: github.ref == 'refs/heads/master' | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
force_orphan: true | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./docs/build/html |