Skip to content

Commit

Permalink
Added doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kerim371 committed Jun 25, 2022
1 parent cc11a0b commit b977223
Show file tree
Hide file tree
Showing 5 changed files with 2,762 additions and 2 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/doxygen-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Doxygen Action

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [ main ]

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: mattnotmitt/doxygen-action@edge
with:
# Working directory
working-directory: "./docs" # default is .
# Path to Doxyfile
doxyfile-path: "./Doxyfile" # default is ./Doxyfile
- name: Deploy Docs
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./docs/build-doxygen/html
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.vscode
build
build-MSVC2019-Debug
build*
CMakeLists.txt.user
Loading

0 comments on commit b977223

Please sign in to comment.