diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..22695ce --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,68 @@ +# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# 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 diff --git a/CMakePresets.json b/CMakePresets.json index 5aa6d6e..0a7fcaa 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -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": [