-
Notifications
You must be signed in to change notification settings - Fork 103
57 lines (48 loc) · 1.33 KB
/
docs.yml
File metadata and controls
57 lines (48 loc) · 1.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
name: "Release Docs"
on:
workflow_dispatch:
pull_request:
branches:
- main
paths:
- 'mkdocs/**'
- 'src/**'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
with:
fetch-depth: 0
- uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs-material
sudo apt-get update
sudo apt-get install -y doxygen
- name: Build API documentation with Doxygen
run: |
cd mkdocs
mkdir -p docs/api
doxygen Doxyfile
echo "Doxygen output created in docs/api/"
- name: Build docs
run: |
cd mkdocs
mkdocs build --clean
echo "MkDocs site built in site/"
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v4.0.0
if: github.event_name == 'pull_request'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./mkdocs/site
publish_branch: gh-pages
user_name: 'GitHub Actions'
user_email: 'actions@github.com'