feat: modify doc link

This commit is contained in:
Xuwznln
2025-09-04 11:10:02 +08:00
parent daa46aaf50
commit 9ac0ad49cb
3 changed files with 30 additions and 28 deletions

View File

@@ -1,4 +1,4 @@
name: 构建和部署文档
name: Deploy Docs
on:
push:
@@ -31,60 +31,60 @@ concurrency:
cancel-in-progress: false
jobs:
# 构建文档
# Build documentation
build:
runs-on: ubuntu-latest
steps:
- name: 检出代码
- name: Checkout code
uses: actions/checkout@v4
with:
ref: ${{ github.event.inputs.branch || github.ref }}
- name: 设置 Python 环境
- name: Setup Python environment
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: 安装系统依赖
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: 安装 Python 依赖
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
# 以开发模式安装包以获取版本信息
# Install package in development mode to get version info
pip install -e .
# 安装文档构建依赖
# Install documentation dependencies
pip install -r docs/requirements.txt
- name: 配置 Pages
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
- name: 构建 Sphinx 文档
- name: Build Sphinx documentation
run: |
cd docs
# 清理之前的构建
# Clean previous builds
rm -rf _build
# 构建 HTML 文档
# Build HTML documentation
python -m sphinx -b html . _build/html -v
- name: 检查构建结果
- name: Check build results
run: |
echo "文档构建完成,检查输出目录:"
echo "Documentation build completed, checking output directory:"
ls -la docs/_build/html/
echo "检查是否有 index.html"
test -f docs/_build/html/index.html && echo "✓ index.html 存在" || echo "✗ index.html 不存在"
echo "Checking for index.html:"
test -f docs/_build/html/index.html && echo "✓ index.html exists" || echo "✗ index.html missing"
- name: 上传构建产物
- name: Upload build artifacts
uses: actions/upload-pages-artifact@v3
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
with:
path: docs/_build/html
# 部署到 GitHub Pages
# Deploy to GitHub Pages
deploy:
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
environment:
@@ -93,6 +93,6 @@ jobs:
runs-on: ubuntu-latest
needs: build
steps:
- name: 部署到 GitHub Pages
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4