Skip to content
This repository was archived by the owner on Mar 25, 2021. It is now read-only.

Commit c1e5130

Browse files
Documentation using Doxygen (#20)
* Saving automated documentation to gh-pages branch using Doxygen * Restrict to pushing documentation to changes on master
1 parent 01549f5 commit c1e5130

File tree

4 files changed

+2520
-2
lines changed

4 files changed

+2520
-2
lines changed

.github/workflows/gh-pages.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: github pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master # Set a branch name to trigger deployment
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- uses: mattnotmitt/doxygen-action@v1
15+
with:
16+
working-directory: '.'
17+
doxyfile-path: './Doxyfile'
18+
19+
- name: Deploy
20+
uses: peaceiris/actions-gh-pages@v3
21+
with:
22+
github_token: ${{ secrets.GITHUB_TOKEN }}
23+
publish_dir: ./public/html/

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,6 @@ Gemfile.lock
2626
.bundle/*
2727
vendor/*
2828
*.cpp.bin*
29+
30+
# Doxygen Generated Files
31+
public

0 commit comments

Comments
 (0)