:WIP: feat(gh-pages) awesome theme #3
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: doxygen-docs | |
on: | |
push: | |
branches: | |
[ main, feat-opt3001-sensor ] #TODO remove not main branch | |
jobs: | |
gh-pages-doxygen-deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository and submodules | |
uses: actions/checkout@v3 | |
with: | |
submodules: recursive | |
# Install required packages for building the documentation | |
- name: Install Doxygen | |
run: sudo apt install doxygen && doxygen --version | |
- name: Install Graphviz | |
run: sudo apt install graphviz | |
# Build the HTML documentation | |
- name: Create documentation | |
run: doxygen ./firmware/iot-risk-logger-stm32l4/Doxyfile | |
# Deploy the HTML documentation to GitHub Pages | |
- name: GH Pages Deployment | |
uses: peaceiris/actions-gh-pages@v3 # https://github.com/peaceiris/actions-gh-pages | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/html #deploy ./html directory to the remote gh-pages branch. | |
config_file: ./firmware/iot-risk-logger-stm32l4/Doxyfile | |
enable_jekyll: false | |
allow_empty_commit: false | |
force_orphan: true | |
publish_branch: gh-pages |