Skip to content

Add action and pipeline concepts (#180) #3

Add action and pipeline concepts (#180)

Add action and pipeline concepts (#180) #3

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: docs (gh-pages)
on:
push:
branches: ["develop"]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy-docs:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz
- name: Install Python dependencies
run: |
python3 -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Build documentation
run: |
cd docs
make html
# env:
# SPHINXOPTS: "-W --keep-going"
- name: Check for broken links
run: |
cd docs
make linkcheck
continue-on-error: true
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
if: success()
with:
path: "docs/build/html"
retention-days: 3 # Custom retention for this artifact
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4