Skip to content

Commit

Permalink
added automatic doxygen docs generator workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
baderouaich committed Sep 25, 2023
1 parent 6ba3e94 commit 0069be0
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/build-doxygen-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# https://github.com/peaceiris/actions-gh-pages

name: Build and Deploy Doxygen Documentation

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Install Doxygen
run: |
sudo apt install doxygen
- name: Run Doxygen
run: | # this will generate a docs/html/** folder (configured in the Doxyfile)
doxygen ./Doxyfile
- name: Deploy generated documentation
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./docs/html # from
destination_dir: ./docs/html # deploy to a subdirectory: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-deploy-to-subdirectory-destination_dir
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake-build-*
build*
build/
.idea/*
tests/tests_bot_token.sh
tests/tests_bot_token.sh

0 comments on commit 0069be0

Please sign in to comment.