axmol/.github/workflows/docs.yml

38 lines
904 B
YAML
Raw Normal View History

name: docs
2021-07-06 14:40:51 +08:00
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
2021-07-07 02:42:04 +08:00
branches:
- dev
2021-07-06 14:40:51 +08:00
paths:
2021-12-31 14:39:08 +08:00
- core/**/*
2021-07-06 14:40:51 +08:00
- docs/**/*
- .github/workflows/docs-ci.yml
jobs:
2021-07-06 15:23:55 +08:00
build-docs:
2021-07-06 14:40:51 +08:00
runs-on: ubuntu-latest
steps:
2022-10-20 22:20:33 +08:00
- uses: actions/checkout@v3
2021-07-06 14:40:51 +08:00
# Build the HTML documentation
- name: Doxygen Action
uses: mattnotmitt/doxygen-action@v1.3.1
with:
2021-07-06 14:42:42 +08:00
doxyfile-path: ./doxygen.config
2021-07-06 14:40:51 +08:00
working-directory: ./docs
# 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: ./docs/html/
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: gh-pages