blob: 00338bbfc9b092d6b5fd4ec3e4816d2f0719a154 (
plain)
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
name: Generate Documentation
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: recursive
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install jinja2 Pygments
sudo apt-get update
sudo apt-get install -y doxygen graphviz
- name: Clone m.css
run: |
git clone https://github.com/mosra/m.css.git
- name: Create documentation directory
run: mkdir -p documentation
- name: Prepare Doxyfile
run: |
doxygen -g Doxyfile
# Configure Doxyfile for m.css and project specifics
sed -i 's/PROJECT_NAME.*=.*/PROJECT_NAME = "Your Project Name"/g' Doxyfile
sed -i 's/INPUT.*=.*/INPUT = README.md fbhl.h/g' Doxyfile
sed -i 's/USE_MDFILE_AS_MAINPAGE.*=.*/USE_MDFILE_AS_MAINPAGE = README.md/g' Doxyfile
sed -i 's/EXTRACT_ALL.*=.*/EXTRACT_ALL = YES/g' Doxyfile
sed -i 's/RECURSIVE.*=.*/RECURSIVE = YES/g' Doxyfile
sed -i 's/GENERATE_HTML.*=.*/GENERATE_HTML = YES/g' Doxyfile
sed -i 's/OUTPUT_DIRECTORY.*=.*/OUTPUT_DIRECTORY = documentation/g' Doxyfile
- name: Generate Documentation with m.css
run: |
python3 m.css/documentation/doxygen.py Doxyfile
- name: Verify documentation exists
run: |
ls -R documentation/html
deploy-docs:
needs: build-docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Download artifact
uses: actions/download-artifact@v4
with:
name: github-pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./documentation/html
publish_branch: gh-pages
|
