-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Using github actions to build docu
- Loading branch information
1 parent
fee3901
commit 5d71e49
Showing
2 changed files
with
31 additions
and
1 deletion.
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,30 @@ | ||
name: Generate Doxygen documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- PRCUN-2883-update-doxygen | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
doxygen: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install Doxygen | ||
run: sudo apt-get install doxygen graphviz -y | ||
|
||
- name: Generate Doxygen configuration and build it | ||
run: mkdir -p doc/build && cd doc/build && cmake .. && make doc | ||
|
||
- name: Deploy to GitHub Pages | ||
if: ${{ github.ref == 'refs/heads/PRCUN-2883-update-doxygen' }} | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: .build/docs/html |
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