mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 12:32:40 +02:00
Add doxygen generation workflow on tag
This commit is contained in:
parent
84b92d9e64
commit
cfdd847f11
39
.github/workflows/doxygen.yaml
vendored
Normal file
39
.github/workflows/doxygen.yaml
vendored
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
name: Build documentation
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags: [ v* ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build documentation
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Get current tag
|
||||||
|
id: vars
|
||||||
|
run: echo ::set-output name=tag::${GITHUB_REF/refs\/tags\//}
|
||||||
|
|
||||||
|
- name: Set up Doxygen
|
||||||
|
run: sudo apt-get install -y doxygen
|
||||||
|
|
||||||
|
- name: Display Doxygen version
|
||||||
|
run: echo "Doxygen version $(doxygen -v)"
|
||||||
|
|
||||||
|
- name: Build documentation
|
||||||
|
run: |
|
||||||
|
cd nx
|
||||||
|
LIBNX_VERSION=${{ steps.vars.outputs.tag }} doxygen Doxyfile
|
||||||
|
|
||||||
|
- name: Deploy 🚀
|
||||||
|
uses: JamesIves/github-pages-deploy-action@3.7.1
|
||||||
|
with:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
BRANCH: gh-pages
|
||||||
|
FOLDER: nx/docs/html
|
||||||
|
CLEAN: true
|
||||||
|
SINGLE_COMMIT: true
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -7,6 +7,8 @@
|
|||||||
*.npdm
|
*.npdm
|
||||||
*.pfs0
|
*.pfs0
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
|
.*/
|
||||||
|
!.github/
|
||||||
debug/
|
debug/
|
||||||
release/
|
release/
|
||||||
lib/
|
lib/
|
||||||
|
@ -38,7 +38,7 @@ PROJECT_NAME = "libnx"
|
|||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = "$(TRAVIS_TAG)"
|
PROJECT_NUMBER = "$(LIBNX_VERSION)"
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
Loading…
Reference in New Issue
Block a user