feat: modify doc link

2025-12-15 13:44:39 +00:00 · 2025-09-04 11:10:02 +08:00
parent daa46aaf50
commit 9ac0ad49cb
3 changed files with 30 additions and 28 deletions
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -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
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@
 # Uni-Lab-OS

 <!-- Language switcher -->
+
 **English** | [中文](README_zh.md)

 [![GitHub Stars](https://img.shields.io/github/stars/dptech-corp/Uni-Lab-OS.svg)](https://github.com/dptech-corp/Uni-Lab-OS/stargazers)
@@ -30,7 +31,7 @@ Join the [Intelligent Organic Chemistry Synthesis Competition](https://bohrium.d

 Detailed documentation can be found at:

- [Online Documentation](https://readthedocs.dp.tech/Uni-Lab/v0.8.0/)
+- [Online Documentation](https://dptech-corp.github.io/Uni-Lab-OS/)

 ## Quick Start

@@ -54,7 +55,7 @@ pip install .

 3. Start Uni-Lab System:

-Please refer to [Documentation - Boot Examples](https://readthedocs.dp.tech/Uni-Lab/v0.8.0/boot_examples/index.html)
+Please refer to [Documentation - Boot Examples](https://dptech-corp.github.io/Uni-Lab-OS/boot_examples/index.html)

 ## Message Format

@@ -74,4 +75,4 @@ This project is licensed under GPL-3.0 - see the [LICENSE](LICENSE) file for det

 ## Contact Us

- GitHub Issues: [https://github.com/dptech-corp/Uni-Lab-OS/issues](https://github.com/dptech-corp/Uni-Lab-OS/issues)
+- GitHub Issues: [https://github.com/dptech-corp/Uni-Lab-OS/issues](https://github.com/dptech-corp/Uni-Lab-OS/issues)
--- a/README_zh.md
+++ b/README_zh.md
@@ -5,6 +5,7 @@
 # Uni-Lab-OS

 <!-- Language switcher -->
+
 [English](README.md) | **中文**

 [![GitHub Stars](https://img.shields.io/github/stars/dptech-corp/Uni-Lab-OS.svg)](https://github.com/dptech-corp/Uni-Lab-OS/stargazers)
@@ -12,7 +13,7 @@
 [![GitHub Issues](https://img.shields.io/github/issues/dptech-corp/Uni-Lab-OS.svg)](https://github.com/dptech-corp/Uni-Lab-OS/issues)
 [![GitHub License](https://img.shields.io/github/license/dptech-corp/Uni-Lab-OS.svg)](https://github.com/dptech-corp/Uni-Lab-OS/blob/main/LICENSE)

-Uni-Lab-OS是一个用于实验室自动化的综合平台，旨在连接和控制各种实验设备，实现实验流程的自动化和标准化。
+Uni-Lab-OS 是一个用于实验室自动化的综合平台，旨在连接和控制各种实验设备，实现实验流程的自动化和标准化。

 ## 🏆 比赛

@@ -30,11 +31,11 @@ Uni-Lab-OS是一个用于实验室自动化的综合平台，旨在连接和控

 详细文档可在以下位置找到:

- [在线文档](https://readthedocs.dp.tech/Uni-Lab/v0.8.0/)
+- [在线文档](https://dptech-corp.github.io/Uni-Lab-OS/)

 ## 快速开始

-1. 配置Conda环境
+1. 配置 Conda 环境

 Uni-Lab-OS 建议使用 `mamba` 管理环境。根据您的操作系统选择适当的环境文件:

@@ -43,7 +44,7 @@ Uni-Lab-OS 建议使用 `mamba` 管理环境。根据您的操作系统选择适
 mamba create -n unilab uni-lab::unilabos -c robostack-staging -c conda-forge
 ```

-2. 安装开发版Uni-Lab-OS:
+2. 安装开发版 Uni-Lab-OS:

 ```bash
 # 克隆仓库
@@ -56,7 +57,7 @@ pip install .

 3. 启动 Uni-Lab 系统:

-请见[文档-启动样例](https://readthedocs.dp.tech/Uni-Lab/v0.8.0/boot_examples/index.html)
+请见[文档-启动样例](https://dptech-corp.github.io/Uni-Lab-OS/boot_examples/index.html)

 ## 消息格式

@@ -76,4 +77,4 @@ Uni-Lab-OS 使用预构建的 `unilabos_msgs` 进行系统通信。您可以在

 ## 联系我们

- GitHub Issues: [https://github.com/dptech-corp/Uni-Lab-OS/issues](https://github.com/dptech-corp/Uni-Lab-OS/issues) 
+- GitHub Issues: [https://github.com/dptech-corp/Uni-Lab-OS/issues](https://github.com/dptech-corp/Uni-Lab-OS/issues)