Skip to content

Commit

Permalink
Deploy doxygen docs to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dantti authored and LeonMatthesKDAB committed Jul 23, 2024
1 parent cf18b75 commit 3817540
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 1 deletion.
65 changes: 65 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
#
# SPDX-License-Identifier: MIT

name: Deploy doxygen to GitHub Pages

on:
workflow_dispatch:
push:
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
Expand Up @@ -65,6 +65,15 @@
"errors": {
"dev": true
}
},
{
"name": "docs",
"displayName": "docs",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build-docs",
"cacheVariables": {
"KDBindings_DOCS" : "ON"
}
}

],
Expand All @@ -84,6 +93,11 @@
{
"name": "clang-tidy",
"configurePreset": "clang-tidy"
},
{
"name": "docs",
"configurePreset": "docs",
"targets": ["docs"]
}
],
"testPresets": [
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ KDBindings requires a C++ compiler with C++17 support.

Find more information at:

* [detailed browsable API reference](https://docs.kdab.com/kdbindings/latest/getting-started/)
* [detailed browsable API reference](https://kdab.github.io/KDBindings/md__home_runner_work_KDBindings_KDBindings_docs_api_docs_getting_started_index.html)
* [our assorted example programs](https://github.com/KDAB/KDBindings/blob/main/examples)

Compatibility with Qt
Expand Down

0 comments on commit 3817540

Please sign in to comment.