Skip to content

Commit

Permalink
generate docs in ci
Browse files Browse the repository at this point in the history
  • Loading branch information
Tsche committed Feb 5, 2024
1 parent cfdccb3 commit 65e320f
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Build documentation

on:
push:
branches: ["master"]
workflow_dispatch:

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build-docs:
runs-on: ubuntu-latest
container: alpine:latest
steps:
- name: Install dependencies
run: |
apk update
apk add --no-cache git doxygen graphviz font-liberation python3 py3-pydot
- name: Checkout
uses: actions/checkout@v4
with:
submodules: 'true'

- name: Checkout correct version of style
working-directory: docs/style
run: git checkout v2.3.1

- name: Generate docs
run: |
mkdir -p build
doxygen docs/Doxyfile
- uses: actions/upload-artifact@master
with:
name: docs-web
path: build/html

deploy-pages:
needs: build-docs

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

permissions:
contents: read
pages: write
id-token: write

runs-on: ubuntu-latest
steps:
- uses: actions/download-artifact@master
with:
name: docs-web
path: html

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: html

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 65e320f

Please sign in to comment.