Skip to content

Commit 82d2436

Browse files
author
Levent Kaya
committedNov 27, 2024·
[ci] theme
1 parent 309bdd8 commit 82d2436

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed
 

‎.github/workflows/docs.yml

+18-12
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,60 @@
11
name: Generate Doxygen Documentation
2-
32
on:
43
push:
54
branches: [master]
65
workflow_dispatch:
7-
86
permissions:
97
contents: write
108
pages: write
119
id-token: write
12-
1310
jobs:
1411
generate-docs:
1512
runs-on: ubuntu-latest
16-
1713
steps:
1814
- name: Checkout Repository
1915
uses: actions/checkout@v4
20-
16+
2117
- name: Install Doxygen and Graphviz
2218
run: |
2319
sudo apt-get update
2420
sudo apt-get install -y doxygen graphviz
25-
21+
22+
- name: Prepare Doxygen Awesome CSS and JS
23+
run: |
24+
mkdir -p docs/css docs/js
25+
wget https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@v2.3.4/doxygen-awesome.css -O docs/css/doxygen-awesome.css
26+
wget https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@v2.3.4/doxygen-awesome-darkmode-toggle.js -O docs/js/doxygen-awesome-darkmode-toggle.js
27+
2628
- name: Create and Configure Doxyfile
2729
run: |
2830
doxygen -g
2931
30-
# Update Doxyfile to apply the Doxygen Awesome theme
32+
# Update Doxyfile configuration
3133
echo "PROJECT_NAME = fbgl" >> Doxyfile
3234
echo "PROJECT_NUMBER = 0.1.0" >> Doxyfile
3335
echo "OUTPUT_DIRECTORY = docs" >> Doxyfile
3436
echo "INPUT = fbgl.h README.md" >> Doxyfile
3537
echo "HTML_OUTPUT = html" >> Doxyfile
3638
echo "USE_MDFILE_AS_MAINPAGE = README.md" >> Doxyfile
39+
40+
# Doxygen Awesome theme configurations
3741
echo "GENERATE_TREEVIEW = YES" >> Doxyfile
3842
echo "FULL_SIDEBAR = NO" >> Doxyfile
3943
echo "HTML_COLORSTYLE = LIGHT" >> Doxyfile
40-
41-
echo "HTML_EXTRA_STYLESHEET = https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@v2.3.4/doxygen-awesome.css https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@v2.3.4/doxygen-awesome-darkmode-toggle.js" >> Doxyfile
4244
echo "DISABLE_INDEX = NO" >> Doxyfile
4345
echo "HTML_DYNAMIC_SECTIONS = YES" >> Doxyfile
44-
46+
47+
# Local CSS and JS paths
48+
echo "HTML_EXTRA_STYLESHEET = docs/css/doxygen-awesome.css" >> Doxyfile
49+
echo "HTML_EXTRA_FILES = docs/js/doxygen-awesome-darkmode-toggle.js" >> Doxyfile
50+
4551
- name: Generate Documentation
4652
run: doxygen Doxyfile
47-
53+
4854
- name: Deploy to GitHub Pages
4955
uses: peaceiris/actions-gh-pages@v3
5056
with:
5157
github_token: ${{ secrets.GITHUB_TOKEN }}
5258
publish_branch: gh-pages
5359
publish_dir: docs/html
54-
force_orphan: true
60+
force_orphan: true

0 commit comments

Comments
 (0)
Please sign in to comment.