Skip to content

Commit e82ce18

Browse files
committed
Add github pages workflow
1 parent ded2205 commit e82ce18

File tree

2 files changed

+61
-8
lines changed

2 files changed

+61
-8
lines changed

.github/workflows/static.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Deploy static content to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["master"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Single deploy job since we're just deploying
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
with:
35+
submodules: true
36+
- name: Setup Pages
37+
uses: actions/configure-pages@v5
38+
39+
- name: Run Doxygen
40+
run: |
41+
mkdir .dx
42+
cd .dx
43+
wget -q https://www.doxygen.nl/files/doxygen-1.12.0.linux.bin.tar.gz
44+
tar xf doxygen-1.12.0.linux.bin.tar.gz --strip-components=1
45+
sudo make install
46+
cd ..
47+
mkdir -p docs/api
48+
doxygen
49+
- name: Upload artifact
50+
uses: actions/upload-pages-artifact@v3
51+
with:
52+
path: 'docs/api/html'
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

Doxyfile

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -965,12 +965,11 @@ WARN_LOGFILE =
965965
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
966966
# Note: If this tag is empty the current directory is searched.
967967

968-
INPUT = src \
969-
LICENSE.md \
970-
README.md \
971-
build/DoxyHome.md \
968+
INPUT = build/DoxyHome.md \
972969
CONTRIBUTING.md \
973-
SECURITY.md
970+
SECURITY.md \
971+
LICENSE.md \
972+
src
974973

975974
# This tag can be used to specify the character encoding of the source files
976975
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1075,8 +1074,7 @@ RECURSIVE = YES
10751074
# Note that relative paths are relative to the directory from which Doxygen is
10761075
# run.
10771076

1078-
EXCLUDE = F:\Workspace\EasySign\src\EasySign.Cli \
1079-
**README.md
1077+
EXCLUDE = F:\Workspace\EasySign\src\EasySign.Cli
10801078

10811079
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
10821080
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -1092,7 +1090,7 @@ EXCLUDE_SYMLINKS = NO
10921090
# Note that the wildcards are matched against the file with absolute path, so to
10931091
# exclude all test directories for example use the pattern */test/*
10941092

1095-
EXCLUDE_PATTERNS =
1093+
EXCLUDE_PATTERNS = README.md
10961094

10971095
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
10981096
# (namespaces, classes, functions, etc.) that should be excluded from the

0 commit comments

Comments
 (0)