Skip to content

Commit

Permalink
Add Doxygen Github Action to generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shamitha-shashidhara committed Nov 18, 2024
1 parent b1e1b4d commit ef54acf
Show file tree
Hide file tree
Showing 6 changed files with 2,782 additions and 7 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/doxygen-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Build and Deploy Doxygen Documentation

on: [workflow_call, pull_request]

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
defaults:
run:
working-directory: ./doc
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install python dependencies
run: |
python -m pip install --upgrade pip
- name: Install doxygen
run: |
sudo apt-get update
sudo apt-get install doxygen
pip install coverxygen
- name: Run doxygen
run: doxygen Doxyfile

- name: Print Doxygen Warning Log
run: cat DoxygenWarningLog.txt

- name: Run coverxygen
run: python3 -m coverxygen --format summary --xml-dir doxygenOut/xml/ --src-dir .. --output doc-coverage.info

- name: Print doc coverage
run: cat doc-coverage.info

- name: Zip doxygen documentation
run: |
mv doxygenOut/html doxygen_docs
zip -r doxygen_docs.zip doxygen_docs
- name: Upload doxygen_docs
uses: actions/upload-artifact@v4
with:
name: doxygen_docs
path: ./doc/doxygen_docs.zip
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ jobs:
build-sphinx-docs:
uses: ./.github/workflows/sphinx-doc-build.yml

build-doxygen-docs:
uses: ./.github/workflows/doxygen-build.yml

publish-docs:
runs-on: ubuntu-latest
needs: build-sphinx-docs
needs: [build-sphinx-docs, build-doxygen-docs]
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand All @@ -31,6 +34,18 @@ jobs:
unzip sphinx_docs.zip
rm sphinx_docs.zip
- name: Download doxygen documentation
uses: actions/download-artifact@v4
with:
name: doxygen_docs
path: ./doc/github_pages

- name: Unzip doxygen documentation
working-directory: ./doc/github_pages
run: |
unzip doxygen_docs.zip
rm doxygen_docs.zip
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
Expand Down
Loading

0 comments on commit ef54acf

Please sign in to comment.