Add docs using doxegen + pipeline for docs #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build and Deploy Docs | |
# Deploy docs only for main | |
on: | |
push: | |
branches: | |
- "main" | |
# Allow deployment to GitHub Pages | |
permissions: | |
pages: write | |
id-token: write | |
jobs: | |
deploy-docs: | |
name: Deploy Docs | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install dependencies | |
run: | | |
sudo apt update && sudo apt install -y doxygen | |
- name: Clone repo | |
uses: actions/checkout@v4 | |
- name: Build docs | |
run: make doc | |
- name: Setup Pages | |
uses: actions/configure-pages@v3 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v2 | |
with: | |
path: 'html' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |