Skip to content

Commit

Permalink
Merge pull request #15 from 2bndy5/master
Browse files Browse the repository at this point in the history
deploy docs using gh-pages
  • Loading branch information
TMRh20 authored Nov 29, 2020
2 parents 930fac3 + a076209 commit cb1f771
Show file tree
Hide file tree
Showing 7 changed files with 577 additions and 571 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: DoxyGen build

on:
pull_request:
branches:
- master
push:
branches:
- master
release:
branches:
- master
types:
- published
- edited

jobs:
build-doxygen:
runs-on: ubuntu-latest

steps:
- name: get latest release version number
id: latest_ver
uses: pozetroninc/github-action-get-latest-release@master
with:
repository: nRF24/RF24Gateway
- name: checkout
uses: actions/checkout@v2
- name: overwrite doxygen tags
run: |
mkdir docs
touch doxygenAction
echo "PROJECT_NUMBER = ${{ steps.latest_ver.outputs.release }}" >> doxygenAction
echo "@INCLUDE = doxygenAction" >> Doxyfile
- name: build doxygen
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: '.'
doxyfile-path: './Doxyfile'
- name: upload to github pages
if: ${{ github.event_name == 'release'}}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# ignore docs folder
docs/
Loading

0 comments on commit cb1f771

Please sign in to comment.