Skip to content

Commit

Permalink
Merge pull request #1 from TheRainbowPhoenix/master
Browse files Browse the repository at this point in the history
Add Doxygen pages auto-generation
  • Loading branch information
TheRainbowPhoenix authored Aug 8, 2024
2 parents 1666f4b + c0118a2 commit c67df16
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Deploy Doxygen to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# 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

env:
BUILD_PATH: "sdk"

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install pandoc and doxygen
run: |
sudo apt install pandoc doxygen graphviz sphinx-doc
- name: Setup python
uses: actions/setup-python@v5
with:
python-version: '3.12'

- name: Build Doxygen
run: |
cd sdk
mkdir -p doc
doxygen Doxyfile
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: sdk/doc

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit c67df16

Please sign in to comment.