Skip to content

Commit 3be09a5

Browse files
committed
feat(docs): add doxygen generator action
1 parent 7b23dda commit 3be09a5

3 files changed

Lines changed: 21 additions & 3 deletions

File tree

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Doxygen GitHub Pages Deploy Action
2+
3+
on:
4+
push:
5+
branches: [ '*' ]
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: DenverCoder1/doxygen-github-pages-action@v1.3.0
12+
with:
13+
github_token: ${{ secrets.GITHUB_TOKEN }}
14+
config_file: Doxyfile.cfg

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule ".github/doxygen-awesome-css"]
2+
path = .github/doxygen-awesome-css
3+
url = https://github.com/jothepro/doxygen-awesome-css.git

Doxyfile.cfg

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ PROJECT_BRIEF = "Engine-3D made in C for EPITECH Hub."
6161
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
6262
# the logo to the output directory.
6363

64-
PROJECT_LOGO = ./Image/Logo_1-200x200.png
64+
PROJECT_LOGO = ./Images/Logo_1-200x200.png
6565

6666
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
6767
# into which the generated documentation will be written. If a relative path is
@@ -1404,7 +1404,8 @@ HTML_EXTRA_STYLESHEET =
14041404
# files will be copied as-is; there are no commands or markers available.
14051405
# This tag requires that the tag GENERATE_HTML is set to YES.
14061406

1407-
HTML_EXTRA_FILES =
1407+
HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome.css \
1408+
doxygen-awesome-css/doxygen-awesome-sidebar-only.css
14081409

14091410
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
14101411
# should be rendered with a dark or light theme.
@@ -1717,7 +1718,7 @@ DISABLE_INDEX = NO
17171718
# The default value is: NO.
17181719
# This tag requires that the tag GENERATE_HTML is set to YES.
17191720

1720-
GENERATE_TREEVIEW = NO
1721+
GENERATE_TREEVIEW = YES
17211722

17221723
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
17231724
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview

0 commit comments

Comments
 (0)