Skip to content

📦 deps(ST25FTM) add library to manage Mailbox transfers #77

📦 deps(ST25FTM) add library to manage Mailbox transfers

📦 deps(ST25FTM) add library to manage Mailbox transfers #77

Workflow file for this run

name: doxygen-docs
on:
push:
branches:
[ main ]
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
# Prepare the Doxygen configuration file
- name: set version
run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./firmware/iot-risk-logger-stm32l4/Doxyfile
# 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: ./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