Skip to content

Commit

Permalink
Add Workflow for Doxygen Document and GitHub Pages (#85)
Browse files Browse the repository at this point in the history
* ignore DS_Store

* add doxygen job

* add Doxyfile

* fix ci

* update checkout version
  • Loading branch information
botamochi6277 authored Apr 14, 2024
1 parent 96fa787 commit af2bff6
Show file tree
Hide file tree
Showing 3 changed files with 2,618 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: A job to build doxgen document and deploy it on github-pages
on:
push:
branches: [main, master, doxygen]
pull_request:
branches: [main, master]
workflow_dispatch:

jobs:
doxygen-job:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- name: download modern theme
run: |
curl -OL https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css
- uses: mattnotmitt/doxygen-action@v1.9.5
- name: Deploy pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "html"
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@ lib/aquestalk_esp32
lib/aquestalk-esp32
src/*.ino
const.h
/tmp/
/tmp/

# for macOS
.DS_Store
Loading

0 comments on commit af2bff6

Please sign in to comment.