Skip to content

feat(Docs): Updated documentation #54

feat(Docs): Updated documentation

feat(Docs): Updated documentation #54

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:
permissions:
contents: write
pages: write
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- name: Run Doxygen
uses: mattnotmitt/[email protected]
with:
doxyfile-path: ./Doxyfile
working-directory: .
- name: Pages Deployment
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./Documentation/html/
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: pages/docs
cname: srl.reye.me