Skip to content

Update README.md

Update README.md #51

name: Deploy Doxygen docs to GitHub Pages
on:
push:
branches:
- humble
pull_request:
branches:
- "*"
# 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:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Doxygen
uses: ssciwr/doxygen-install@v1
with:
version: 1.13.2
- name: Install Graphviz
run: sudo apt update && sudo apt-get install graphviz -y
- name: Run Doxygen
run: doxygen doc/Doxyfile
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc/html
deploy:
name: Deploy
runs-on: ubuntu-latest
if: github.event_name == 'push'
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4