axmol/.github/workflows/docs.yml

36 lines
847 B
YAML

name: docs
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches:
- dev
paths:
- core/**/*
- docs/**/*
- .github/workflows/docs-ci.yml
workflow_dispatch:
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
# Build the HTML documentation
- name: Build HTML documentation
run: ./tools/unix-ci/generate_docs.sh
# 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