Skip to content

Release

Release #785

Workflow file for this run

name: Build Documentation
on:
push:
branches:
- main
- release
- dev
pull_request:
paths:
- "docs/**"
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[ci skip]')"
steps:
- uses: actions/checkout@v2
name: Check out source-code repository
- name: Setup Python
uses: actions/setup-python@v2.1.4
with:
python-version: 3.8
- name: Upgrade and install pip and wheel
run: python -m pip install --upgrade pip wheel
- name: Install doc dependencies
run: pip install -r docs/requirements.txt
- name: Build docs
run: |
cd docs
make html
- name: Deploy
if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html