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 11, 2024
1 parent 909e181 commit 2036dbd
Show file tree
Hide file tree
Showing 5 changed files with 2,728 additions and 10 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/doc-publish.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
name: Publish Documentation

on:
push:
branches:
- main
on: [push, pull_request]

permissions:
contents: write

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

publish-docs:
runs-on: ubuntu-latest
Expand All @@ -29,4 +28,5 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
force_orphan: true
destination_dir: docs/sphinx
keep_files: true
32 changes: 32 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
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: Install doxygen
run: sudo apt-get install doxygen

- name: Run doxygen
run: doxygen Doxyfile

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

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/doxygenOut/html
destination_dir: docs/doxygen
force_orphan: true
Loading

0 comments on commit 2036dbd

Please sign in to comment.