Skip to content

Commit

Permalink
finish setup doxygen (#458)
Browse files Browse the repository at this point in the history
* update and setup doxygen file

* move to docs/html

* Readme - Add link to the documentation
  • Loading branch information
coco875 committed Oct 14, 2023
1 parent 10e0e61 commit d71e1c7
Show file tree
Hide file tree
Showing 4 changed files with 467 additions and 241 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/doxygen-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Doxygen GitHub Pages Deploy Action

on:
push:
branches:
- master
workflow_dispatch:

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: DenverCoder1/doxygen-github-pages-action@v1.3.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html
config_file: Doxyfile
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,6 @@ expected/*
!/sound/**/*custom*/**/*.aiff
!/assets/**/*custom*.bin
!/assets/**/*custom*/**/*.bin

# Doxygen
docs/html/*
Loading

0 comments on commit d71e1c7

Please sign in to comment.