forked from ARMmbed/mbed-os
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs generation workflow (ARMmbed#45)
* Add docs generation workflow * remove extraneous backslash
- Loading branch information
1 parent
60a3a4e
commit e833ba1
Showing
5 changed files
with
57 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Documentation | ||
|
||
# Controls when the action will run. Triggers the workflow on push or pull request | ||
# events but only for the master branch | ||
on: | ||
push: | ||
branches: [ master ] | ||
|
||
jobs: | ||
build-documentation: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
submodules: recursive | ||
|
||
- name: Create BUILD folder | ||
run: | | ||
mkdir -p ${{ github.workspace }}/BUILD | ||
# Build the HTML documentation | ||
- name: Doxygen Action | ||
uses: mattnotmitt/doxygen-action@v1.1.0 | ||
with: | ||
doxyfile-path: ./doxyfile_options | ||
|
||
# Deploy the HTML documentation to GitHub Pages | ||
- name: GH Pages Deployment | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./BUILD/html/ | ||
enable_jekyll: false | ||
allow_empty_commit: false | ||
force_orphan: true | ||
publish_branch: docs-master |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "doxygen-awesome-css"] | ||
path = tools/doxygen-awesome-css | ||
url = https://github.com/jothepro/doxygen-awesome-css.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule doxygen-awesome-css
added at
a3c119
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.