update #5
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: documentation | |
# see: https://coderefinery.github.io/documentation/gh_workflow/ | |
# see: https://github.com/actions/setup-python | |
on: [push, pull_request, workflow_dispatch] | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.11" | |
- name: 安装依赖1 | |
# 安装当前的项目作为一个包 | |
run: | | |
pip install . | |
- name: 安装依赖2 | |
run: | | |
pip install -r requirements.doc.txt | |
- name: Sphinx 构建 | |
working-directory: ./ | |
run: | | |
sphinx-build doc/cn build/cn/html | |
- name: 部署到 GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sync-docs' }} | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./build/cn/html | |
force_orphan: true |