Skip to content

Merge pull request #143 from CU-Robotics/feature-damage-status-sending #123

Merge pull request #143 from CU-Robotics/feature-damage-status-sending

Merge pull request #143 from CU-Robotics/feature-damage-status-sending #123

Workflow file for this run

# This workflow generates documentation for a project using Doxygen and sets it up for GitHub pages. It will push the
# documentation onto a special orphan branch to avoid cluttering the source code. This implementation comes from
# https://ntamonsec.blogspot.com/2020/06/github-actions-doxygen-documentation.html
name: Deploy Documentation
# Controls when the action will run.
on:
push:
branches: [ main ]
jobs:
build-documentation:
runs-on: ubuntu-latest
steps:
# Checkout sets up working directory as project root
- name: Checkout
uses: actions/checkout@v4
# Run Doxygen Build
- name: Run Doxygen
uses: mattnotmitt/doxygen-action@v1.9.1
with:
doxyfile-path: ./Doxyfile # Docs build settings
working-directory: .
enable-latex: false # could enable latex later if needed, but it has a slow install.
- name: Pages Deployment
if: success() || failure() # (Attempt to) deploy docs even if doxygen fails
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html/
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: doxygen-documentation