Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploy doxygen docs to GitHub pages
Browse files Browse the repository at this point in the history
dantti committed Jul 22, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent e83a0f2 commit d783e4e
Showing 2 changed files with 82 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
#
# SPDX-License-Identifier: MIT

name: Deploy doxygen to GitHub Pages

on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# 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:
runs-on: ubuntu-latest

steps:
- name: Install Dependencies on Linux
run: |
sudo apt update -qq
sudo apt install -y doxygen
- name: Checkout sources
uses: actions/checkout@v4
with:
submodules: recursive

- name: Install ninja-build tool
uses: aseprite/get-ninja@main

- name: Configure project
run: cmake -S . --preset=docs

- name: Create docs
run: cmake --build --preset=docs

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

# Deployment job, what was uploaded to artifact
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
14 changes: 14 additions & 0 deletions CMakePresets.json
Original file line number Diff line number Diff line change
@@ -65,6 +65,15 @@
"errors": {
"dev": true
}
},
{
"name": "docs",
"displayName": "docs",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build-docs",
"cacheVariables": {
"KDBindings_DOCS" : "ON"
}
}

],
@@ -84,6 +93,11 @@
{
"name": "clang-tidy",
"configurePreset": "clang-tidy"
},
{
"name": "docs",
"configurePreset": "docs",
"targets": ["docs"]
}
],
"testPresets": [

0 comments on commit d783e4e

Please sign in to comment.