Skip to content

Commit

Permalink
doc: Build doxygen documentation
Browse files Browse the repository at this point in the history
The Doxygen documentation is generated and uploaded with GitHub actions.

Currently the code is not yet thoroughly documented.
  • Loading branch information
LukasWoodtli committed Oct 24, 2024
1 parent 1623d69 commit eb9004d
Show file tree
Hide file tree
Showing 4 changed files with 2,720 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Build Documentation

on:
pull_request:
branches: [master]

jobs:
coverage:
runs-on: ubuntu-24.04

steps:
- name: Checkout code including full history and submodules
uses: actions/checkout@v4
with:
submodules: true
fetch-depth: 0

- name: Install dependencies from APT repository
run: |
sudo apt-get update
sudo apt-get install doxygen graphviz
- name: Build Doxygen documentation
run: tools/ci/run_ci.sh --run-doxygen

- name: Upload Doxygen documentation
uses: actions/upload-artifact@v4
with:
name: Doxygen documentation (HTML)
path: build-wakaama/doxygen_out
Loading

0 comments on commit eb9004d

Please sign in to comment.