Skip to content

Commit 3c5356e

Browse files
committed
Doxygen documentation was updated
1 parent 2b0e1d6 commit 3c5356e

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

.github/Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ PROJECT_LOGO =
6868
# entered, it will be relative to the location where doxygen was started. If
6969
# left blank the current directory will be used.
7070

71-
OUTPUT_DIRECTORY =
71+
OUTPUT_DIRECTORY = public
7272

7373
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
7474
# sub-directories (in 2 levels) under the output directory of each output format
@@ -1336,7 +1336,7 @@ GENERATE_HTML = YES
13361336
# The default directory is: html.
13371337
# This tag requires that the tag GENERATE_HTML is set to YES.
13381338

1339-
HTML_OUTPUT = html
1339+
HTML_OUTPUT = .
13401340

13411341
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
13421342
# generated HTML page (for example: .htm, .php, .asp).
@@ -1974,7 +1974,7 @@ EXTRA_SEARCH_MAPPINGS =
19741974
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
19751975
# The default value is: YES.
19761976

1977-
GENERATE_LATEX = YES
1977+
GENERATE_LATEX = NO
19781978

19791979
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
19801980
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

.github/workflows/doxygen.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,18 @@ jobs:
2424
with:
2525
doxyfile-path: ".github/Doxyfile"
2626

27+
- name: Upload generated site (artifact)
28+
uses: actions/upload-artifact@v4
29+
with:
30+
name: doxygen-public
31+
path: public
32+
if-no-files-found: error
33+
2734
- name: Doxygen Deployment
2835
uses: peaceiris/actions-gh-pages@v4
2936
with:
3037
github_token: ${{ secrets.GITHUB_TOKEN }}
31-
publish_branch: gh-pages
38+
publish_branch: gh-pages
39+
publish_dir: public
40+
exclude_assets: .github
41+
enable_jekyll: false

0 commit comments

Comments
 (0)