Skip to content

Commit 33cc9ee

Browse files
committed
first pass at doxygen for gh-pages
1 parent 9f7c137 commit 33cc9ee

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

.github/workflows/doxygen.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Deploy Doxygen Docs
2+
3+
on:
4+
push:
5+
branches: [doxygen]
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
- name: Generate and Deploy Doxygen Docs
16+
uses: DenverCoder1/doxygen-github-pages-action@v2.0.0
17+
with:
18+
github_token: ${{ secrets.GITHUB_TOKEN }}
19+
config_file: doc/Doxyfile
20+
folder: html
21+
branch: gh-pages

doc/Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -844,7 +844,7 @@ WARN_LOGFILE =
844844
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
845845
# Note: If this tag is empty the current directory is searched.
846846

847-
INPUT = ../src
847+
INPUT = README.md src
848848

849849
# This tag can be used to specify the character encoding of the source files
850850
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1023,7 +1023,7 @@ FILTER_SOURCE_PATTERNS =
10231023
# (index.html). This can be useful if you have a project on for instance GitHub
10241024
# and want to reuse the introduction page also for the doxygen output.
10251025

1026-
USE_MDFILE_AS_MAINPAGE =
1026+
USE_MDFILE_AS_MAINPAGE = README.md
10271027

10281028
#---------------------------------------------------------------------------
10291029
# Configuration options related to source browsing
@@ -1221,7 +1221,7 @@ HTML_HEADER =
12211221
# that doxygen normally uses.
12221222
# This tag requires that the tag GENERATE_HTML is set to YES.
12231223

1224-
HTML_FOOTER = doxygen_footer.html
1224+
HTML_FOOTER = doc/doxygen_footer.html
12251225

12261226
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
12271227
# sheet that is used by each HTML page. It can be used to fine-tune the look of

0 commit comments

Comments
 (0)