Skip to content

Commit 94472dd

Browse files
Generate documentation (#57)
* Generate documentation * Remove explicit inline * Set new coverage
1 parent fab1981 commit 94472dd

File tree

7 files changed

+2979
-23
lines changed

7 files changed

+2979
-23
lines changed

.github/workflows/doc.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: doc
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths-ignore:
8+
- '.vscode/**'
9+
- 'LICENSE'
10+
pull_request:
11+
paths-ignore:
12+
- '.vscode/**'
13+
- 'LICENSE'
14+
workflow_dispatch:
15+
16+
jobs:
17+
build:
18+
name: Documentation
19+
runs-on: ubuntu-latest
20+
21+
permissions:
22+
contents: write
23+
24+
steps:
25+
- uses: actions/checkout@v4
26+
27+
- name: Install dependencies
28+
run: |
29+
sudo apt-get update
30+
sudo apt-get install -y doxygen graphviz
31+
32+
- name: Generate documentation
33+
run: doxygen
34+
35+
- name: Deploy documentation
36+
uses: peaceiris/actions-gh-pages@v4
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ./docs
40+
if: github.ref == 'refs/heads/master'

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.idea
22
*build*
3+
docs

0 commit comments

Comments
 (0)