Skip to content

Commit 81ddb6b

Browse files
authored
docs: Add Doxygen documents (#155)
1 parent d87899f commit 81ddb6b

File tree

18 files changed

+3809
-393
lines changed

18 files changed

+3809
-393
lines changed

.github/workflows/doc.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: build doc
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
branches:
8+
- "**"
9+
paths:
10+
- ".github/workflows/doc.yml"
11+
- "include/**"
12+
- "Doxyfile"
13+
14+
workflow_dispatch:
15+
16+
jobs:
17+
meta:
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: write
21+
steps:
22+
- uses: actions/checkout@v3
23+
with:
24+
fetch-depth: 0
25+
- name: Build Doxygen
26+
uses: mattnotmitt/doxygen-action@v1.9.5
27+
- name: Deploy to GitHub Pages
28+
uses: peaceiris/actions-gh-pages@v3
29+
with:
30+
github_token: ${{ secrets.GITHUB_TOKEN }}
31+
publish_dir: ./docs-gen/html

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# docs
22
docs/node_modules
33
docs/.vuepress/.temp
4+
docs-gen
45
# Prerequisites
56
*.d
67

0 commit comments

Comments
 (0)