update for CI

Author: shunk031

.github/workflows/gh-pages.yaml

@@ -0,0 +1,46 @@
+name: Document
+
+on: push
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Typo check
+        uses: crate-ci/typos@v1.29.0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Setup Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Build HTML
+        run: uv run sphinx-build -M html docs/source docs/build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-docs
+          path: docs/build/html
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          publish_branch: gh-pages

docs/source/conf.py

@@ -72,3 +72,4 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+html_favicon = "https://huggingface.co/front/assets/huggingface_logo-noborder.svg"