Skip to content

Commit e833ba1

Browse files
Add docs generation workflow (#45)
* Add docs generation workflow * remove extraneous backslash
1 parent 60a3a4e commit e833ba1

File tree

5 files changed

+57
-3
lines changed

5 files changed

+57
-3
lines changed

.github/workflows/docs.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Documentation
2+
3+
# Controls when the action will run. Triggers the workflow on push or pull request
4+
# events but only for the master branch
5+
on:
6+
push:
7+
branches: [ master ]
8+
9+
jobs:
10+
build-documentation:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
with:
16+
submodules: recursive
17+
18+
- name: Create BUILD folder
19+
run: |
20+
mkdir -p ${{ github.workspace }}/BUILD
21+
22+
# Build the HTML documentation
23+
- name: Doxygen Action
24+
uses: mattnotmitt/[email protected]
25+
with:
26+
doxyfile-path: ./doxyfile_options
27+
28+
# Deploy the HTML documentation to GitHub Pages
29+
- name: GH Pages Deployment
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: ./BUILD/html/
34+
enable_jekyll: false
35+
allow_empty_commit: false
36+
force_orphan: true
37+
publish_branch: docs-master

.gitmodules

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

doxyfile_options

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ PROJECT_BRIEF =
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
PROJECT_LOGO =
54+
PROJECT_LOGO = tools/mbed-ce_55x55.png
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is
@@ -142,6 +142,17 @@ INLINE_INHERITED_MEMB = YES
142142

143143
FULL_PATH_NAMES = NO
144144

145+
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the FULL_SIDEBAR
146+
# option determines if the side bar is limited to only the treeview area (value NO) or
147+
# if it should extend to the full height of the window (value YES). Setting this to YES
148+
# gives a layout similar to https://docs.readthedocs.io with more room for contents, but
149+
# less room for the project logo, title, and description.
150+
# If either GENERATE_TREEVIEW or DISABLE_INDEX is set to NO, this option has no effect.
151+
# The default value is: NO.
152+
# This tag requires that the tag GENERATE_HTML is set to YES.
153+
154+
FULL_SIDEBAR = NO
155+
145156
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146157
# Stripping is only done if one of the specified strings matches the left-hand
147158
# part of the path. The tag can be used to show relative paths in the file list.
@@ -1162,7 +1173,8 @@ HTML_STYLESHEET =
11621173
# list). For an example see the documentation.
11631174
# This tag requires that the tag GENERATE_HTML is set to YES.
11641175

1165-
HTML_EXTRA_STYLESHEET =
1176+
HTML_EXTRA_STYLESHEET = tools/doxygen-awesome-css/doxygen-awesome.css \
1177+
tools/doxygen-awesome-css/doxygen-awesome-sidebar-only.css
11661178

11671179
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
11681180
# other source files which should be copied to the HTML output directory. Note
@@ -1448,7 +1460,7 @@ DISABLE_INDEX = NO
14481460
# The default value is: NO.
14491461
# This tag requires that the tag GENERATE_HTML is set to YES.
14501462

1451-
GENERATE_TREEVIEW = NO
1463+
GENERATE_TREEVIEW = YES
14521464

14531465
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
14541466
# doxygen will group on one line in the generated HTML documentation.
@@ -2101,6 +2113,7 @@ PREDEFINED = DOXYGEN_ONLY \
21012113
DEVICE_QSPI \
21022114
DEVICE_STORAGE \
21032115
DEVICE_WATCHDOG \
2116+
DEVICE_LOCALFILESYSTEM \
21042117
"TFM_LVL=1" \
21052118
"MBED_DEPRECATED_SINCE(d, m)=" \
21062119
"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=" \

tools/doxygen-awesome-css

Submodule doxygen-awesome-css added at a3c119b

tools/mbed-ce_55x55.png

2.66 KB
Loading

0 commit comments

Comments
 (0)