Skip to content

整理: ビルド CI step を分割 (#1294) #93

整理: ビルド CI step を分割 (#1294)

整理: ビルド CI step を分割 (#1294) #93

Workflow file for this run

# API docs HTML ファイルを生成し、`gh-pages` ブランチへの push によって GitHub Pages 上のドキュメントとして公開
name: upload-docs
on:
push:
branches:
- "master"
env:
PYTHON_VERSION: "3.11.3"
PUBLISH_DIR: "./docs/api"
PUBLISH_BRANCH: "gh-pages"
DESTINATION_DIR: "api"
defaults:
run:
shell: bash
jobs:
upload-doc:
runs-on: ubuntu-20.04
steps:
- name: <Setup> Check out the repository
uses: actions/checkout@v4
- name: <Setup> Set up Python
id: setup-python
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
cache: pip
- name: <Setup> Install Python dependencies
run: |
pip install -r requirements.txt
- name: <Build> Make documents
run: |
PYTHONPATH=. python build_util/make_docs.py
- name: <Deploy> Deploy documents to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ env.PUBLISH_DIR }}
publish_branch: ${{ env.PUBLISH_BRANCH }}
destination_dir: ${{ env.DESTINATION_DIR }}