docs.yml

name: Build and Deploy Sphinx Docs

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout source
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          # 如果文档在 docs/ 目录，确保有 Sphinx 和 Furo
          pip install sphinx furo

      - name: Build documentation
        run: |
          sphinx-build -b html docs/source docs/_build/html

      - name: Upload built docs as artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs-html
          path: docs/_build/html/

  deploy:
    runs-on: ubuntu-latest
    needs: build
    permissions:
      contents: write
    steps:
      - name: Checkout source
        uses: actions/checkout@v4

      - name: Download built docs
        uses: actions/download-artifact@v4
        with:
          name: docs-html
          path: docs/_build/html

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/_build/html