Skip to content

merge: Ignore Git credential.helper for passed credentials #828

merge: Ignore Git credential.helper for passed credentials

merge: Ignore Git credential.helper for passed credentials #828

Workflow file for this run

# SPDX-FileCopyrightText: Copyright DB Netz AG and the capellambse contributors
# SPDX-License-Identifier: CC0-1.0
name: Docs
on:
workflow_dispatch:
push:
branches: [master]
jobs:
sphinx:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
cache: pip
cache-dependency-path: pyproject.toml
python-version: "3.11"
- 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
run: make -C docs html
- name: Archive the docs
# https://github.com/actions/upload-artifact#too-many-uploads-resulting-in-429-responses
run: (cd docs/build/html && zip -Xr ../html.zip .)
- name: Upload built docs as artifact
uses: actions/upload-artifact@v3
with:
name: Documentation
path: docs/build/html.zip
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