Skip to content

docs: add comprehensive terminology glossary (Chinese / English / Jap… #8

docs: add comprehensive terminology glossary (Chinese / English / Jap…

docs: add comprehensive terminology glossary (Chinese / English / Jap… #8

Workflow file for this run

name: Documentation
on:
push:
branches:
- master
paths:
- 'docs/**'
- 'pymahjong/**'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: write
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install documentation dependencies
run: pip install sphinx furo sphinx-autodoc-typehints myst-parser sphinx-copybutton
- name: Build documentation
run: |
cd docs
make html
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: docs
path: docs/_build/html/
deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
steps:
- uses: actions/download-artifact@v4
with:
name: docs
path: site/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site