Docs & Repo Improvements (#27) #9
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 | |
# Controls when the action will run. Triggers the workflow on push or pull request | |
# events but only for the master branch | |
on: | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/[email protected] | |
- name: Checkout Doxygen Awesome | |
uses: Mushus/[email protected] | |
with: | |
submodulePath: ./docs/doxygen-awesome-css | |
- name: Generate Documentation | |
uses: mattnotmitt/doxygen-action@edge | |
with: | |
doxyfile-path: "docs/Doxyfile" | |
- name: Deploy | |
uses: JamesIves/[email protected] | |
with: | |
branch: gh-pages # The branch the action should deploy to. | |
folder: ./docs-output/html # The folder the action should deploy. |