Skip to content

Commit

Permalink
Deploy doxygen-generated docs to Github Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
zenden2k committed Mar 10, 2024
1 parent 3246c6b commit 7d03841
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- 'master'
paths:
- Source/**
- Docs/**
- Dist/DocGen/**

# 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

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4

# Install Doxygen
- name: Install Doxygen
run: sudo apt install doxygen && doxygen --version

- name: Install Graphviz
run: sudo apt install graphviz

# Create documentation
- name: Create documentation
run: ./generate.sh
working-directory: ${{github.workspace}}/Dist/DocGen/

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: './Docs/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 7d03841

Please sign in to comment.