规范化,api文档搭建 #1
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: 构建并部署文档到 GitHub Pages | |
on: | |
push: | |
branches: [main] | |
pull_request: | |
branches: [main] | |
workflow_dispatch: | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build-and-deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: 设置Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.x' | |
- name: 安装依赖 | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r docs/requirements.txt | |
pip install -r requirements.txt | |
- name: 生成 API 文档 | |
run: | | |
sphinx-apidoc -o docs/source/modules ../ha4t/ --extensions EXTENSIONS -e | |
- name: 构建文档 | |
run: | | |
cd docs | |
make html | |
- name: Setup Pages | |
uses: actions/configure-pages@v5 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: './docs/build/html' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |