Skip to content

Commit 6705b24

Browse files
author
nullccxsy
committed
feat: add MkDocs with Doxygen integration
- Added Doxygen configuration file for API documentation generation. - Introduced a build script for MkDocs documentation. - Removed outdated documentation files and replaced them with a structured MkDocs setup.
1 parent faf73f0 commit 6705b24

File tree

18 files changed

+5795
-1085
lines changed

18 files changed

+5795
-1085
lines changed

.github/workflows/docs.yml

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ on:
55
branches:
66
- main
77
paths:
8-
- 'docs/**'
9-
- 'mkdocs.yml'
8+
- 'mkdocs/**'
9+
- 'src/**'
1010
pull_request:
1111
branches:
1212
- main
1313
paths:
14-
- 'docs/**'
15-
- 'mkdocs.yml'
14+
- 'mkdocs/**'
15+
- 'src/**'
1616

1717
permissions:
1818
contents: read
@@ -39,17 +39,31 @@ jobs:
3939
run: |
4040
python -m pip install --upgrade pip
4141
pip install mkdocs-material
42+
sudo apt-get update
43+
sudo apt-get install -y doxygen
4244
4345
- name: Setup Pages
4446
uses: actions/configure-pages@v4
4547

48+
- name: Build API documentation with Doxygen
49+
run: |
50+
cd mkdocs
51+
mkdir -p docs/api
52+
doxygen Doxyfile
53+
4654
- name: Build with MkDocs
47-
run: mkdocs build --clean
55+
run: |
56+
cd mkdocs
57+
mkdocs build --clean
58+
59+
- name: Copy CNAME file
60+
run: |
61+
cp mkdocs/CNAME mkdocs/site/CNAME
4862
4963
- name: Upload artifact
5064
uses: actions/upload-pages-artifact@v3
5165
with:
52-
path: ./site
66+
path: ./mkdocs/site
5367

5468
deploy:
5569
environment:

0 commit comments

Comments
 (0)