Skip to content

Commit 17d53b9

Browse files
authored
Merge pull request #3 from KredeGC/dev
Docs generation
2 parents 1211b7e + 3a3cee4 commit 17d53b9

File tree

3 files changed

+42
-18
lines changed

3 files changed

+42
-18
lines changed

.github/workflows/docs.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
tagName:
7+
description: 'Test'
8+
type: boolean
9+
10+
jobs:
11+
Docs:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
actions: read
15+
contents: write
16+
pull-requests: write
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v3
20+
- name: Checkout doxygen awesome
21+
uses: actions/checkout@v3
22+
with:
23+
repository: jothepro/doxygen-awesome-css
24+
path: doxygen-awesome-css
25+
- name: Install doxygen & zip
26+
run: sudo apt-get update && sudo apt-get install doxygen graphviz zip -y
27+
- name: Generate Doxygen Documentation
28+
run: doxygen Doxyfile
29+
- name: Create .nojekyll
30+
run: touch docs/html/.nojekyll
31+
- name: Deploy Documentation to branch
32+
uses: JamesIves/github-pages-deploy-action@v4
33+
with:
34+
branch: docs
35+
folder: docs/html

.github/workflows/release.yml

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,6 @@ jobs:
2626
steps:
2727
- name: Checkout
2828
uses: actions/checkout@v3
29-
- name: Install doxygen & zip
30-
run: sudo apt-get update && sudo apt-get install doxygen graphviz zip -y
31-
- name: Generate Doxygen Documentation
32-
run: doxygen Doxyfile
33-
- name: Create .nojekyll
34-
run: touch docs/html/.nojekyll
35-
- name: Deploy Documentation to branch
36-
uses: JamesIves/github-pages-deploy-action@v4
37-
with:
38-
branch: docs
39-
folder: docs/html
4029
- name: Copy LICENSE
4130
run: cp LICENSE include/bitstream/LICENSE
4231
- name: Copy NETSTACKLICENSE

Doxyfile

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ FILE_PATTERNS = *.c \
174174
*.ice
175175
RECURSIVE = YES
176176
EXCLUDE = test \
177-
doxygen-awesome
177+
doxygen-awesome-css
178178
EXCLUDE_SYMLINKS = NO
179179
EXCLUDE_PATTERNS =
180180
EXCLUDE_SYMBOLS =
@@ -215,14 +215,14 @@ IGNORE_PREFIX =
215215
GENERATE_HTML = YES
216216
HTML_OUTPUT = html
217217
HTML_FILE_EXTENSION = .html
218-
HTML_HEADER = doxygen-awesome/header.html
218+
HTML_HEADER = doxygen-awesome-css/doxygen-custom/header.html
219219
HTML_FOOTER =
220220
HTML_STYLESHEET =
221-
HTML_EXTRA_STYLESHEET = doxygen-awesome/doxygen-awesome.css \
222-
doxygen-awesome/doxygen-awesome-sidebar-only.css
223-
HTML_EXTRA_FILES = doxygen-awesome/doxygen-awesome-fragment-copy-button.js \
224-
doxygen-awesome/doxygen-awesome-paragraph-link.js \
225-
doxygen-awesome/doxygen-awesome-interactive-toc.js
221+
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
222+
doxygen-awesome-css/doxygen-awesome-sidebar-only.css
223+
HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
224+
doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
225+
doxygen-awesome-css/doxygen-awesome-interactive-toc.js
226226
HTML_COLORSTYLE = AUTO_LIGHT
227227
HTML_COLORSTYLE_HUE = 220
228228
HTML_COLORSTYLE_SAT = 100

0 commit comments

Comments
 (0)