Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Automatic Build and Deployment of Doxygen Documentation to GitHub Pages #817

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add Automatic Build and Deployment of Doxygen Documentation to GitHub Pages #817

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
931282b
Add Automatic Doxygen Build and Deploy to GitHub Pages
ngpaladi Feb 2, 2025
cc1a8b7
Fix Path
ngpaladi Feb 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/DoxygenBuild.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Deploy Doxygen Documentation to Pages

on:
push:
branches: [master] # branch to trigger deployment

jobs:
pages:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
submodules: "true"
- name: Install Dependencies
run: sudo apt-get update && sudo apt-get install -y doxygen make graphviz
shell: bash
- name: Build Documentation
id: build
run: cd doc && make html && touch html/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc/html/
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4