迁移到 uv 管理文档依赖

Author: Prodesire

.github/workflows/pages.yml

@@ -23,16 +23,19 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.8"
+          python-version: "3.12"
 
       - name: Configure Pages
         uses: actions/configure-pages@v5
 
       - name: Install dependencies
-        run: make install
+        run: uv sync --python 3.12 --frozen --no-install-project
 
       - name: Build documentation
         run: make html

Makefile

@@ -1,7 +1,7 @@
 .DEFAULT_GOAL := help
 
-PYENV_PYTHON := $(shell if command -v pyenv >/dev/null 2>&1 && pyenv versions --bare | grep -qx '3.8.13'; then printf 'PYENV_VERSION=3.8.13 pyenv exec python'; fi)
-PYTHON ?= $(if $(PYENV_PYTHON),$(PYENV_PYTHON),python3)
+UV ?= uv
+PYTHON_VERSION ?= 3.12
 VENV ?= .venv
 PORT ?= 8005
 
@@ -16,7 +16,7 @@ DOC_TARGETS := dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  install   create $(VENV) and install dependencies"
+	@echo "  install   create $(VENV) with uv and install dependencies"
 	@echo "  html      build standalone HTML files"
 	@echo "  serve     build and serve docs at http://localhost:$(PORT)/"
 	@echo "  clean     remove generated documentation files"
@@ -25,11 +25,9 @@ help:
 
 install: $(INSTALL_STAMP)
 
-$(INSTALL_STAMP): requirements.txt
-	@test -n "$(PYTHON)" || (echo "python3 is required" && exit 1)
-	$(PYTHON) -m venv $(VENV)
-	$(VENV_PYTHON) -m pip install --upgrade pip
-	$(VENV_PYTHON) -m pip install -r requirements.txt
+$(INSTALL_STAMP): pyproject.toml uv.lock Makefile
+	@command -v $(UV) >/dev/null 2>&1 || (echo "uv is required. Install it from https://docs.astral.sh/uv/" && exit 1)
+	$(UV) sync --python $(PYTHON_VERSION) --frozen --no-install-project
 	@touch $(INSTALL_STAMP)
 
 build: html

Pipfile

@@ -14,7 +14,7 @@ Python最佳实践指南中文版
 
 项目翻译来自 `Hitchhiker's Guide to Python <https://github.com/kennethreitz/python-guide>`_。
 
-GitHub Pages 文档地址 `Python最佳实践指南中文版 <https://prodesire.github.io/Python-Guide-CN/>`_。
+文档地址 `Python最佳实践指南中文版 <https://prodesire.github.io/Python-Guide-CN/>`_。
 
 -----------
 
@@ -37,22 +37,14 @@ GitHub Pages 文档地址 `Python最佳实践指南中文版 <https://prodesire.
 - 测试: Jenkins & tox 指南
 - 如何更方便地通过 ``git`` 连接 ``hg``
 
-如果您不习惯阅读reStructuredText形式的文档, 这里有一份同步更新的 `HTML版文档，请戳它 <https://prodesire.github.io/Python-Guide-CN/>`_。
-
-
 使用指南
 ============================
 1. 下载zip文件或clone到本地，并进入到项目根目录
 2. 打开命令行，运行 ``make help`` 查看可用命令
-3. 打开命令行，运行 ``make install`` 创建虚拟环境并安装依赖
+3. 打开命令行，运行 ``make install`` 使用 uv 根据 ``pyproject.toml`` 创建虚拟环境并安装依赖
 4. 打开命令行，运行 ``make html`` 构建文档；或运行 ``make serve`` 构建并启动本地文档网站
 5. ``make html`` 会在 ``docs/_build/html`` 中生成 HTML 文件，``make serve`` 默认会在 ``http://localhost:8005/`` 运行文档网站
 
-或者
----------------------------
-- 直接访问 `Python最佳实践指南中文版 <https://prodesire.github.io/Python-Guide-CN/>`_。
-
-
 翻译指南
 ============================
 1. 将 `python-guide <https://github.com/kennethreitz/python-guide>`_ 项目和本项目的master分支更新

Readme.rst

@@ -23,10 +23,7 @@ Python-guide目前还在开发中，欢迎大家贡献代码。
 要做的事
 *********
 
-如果您想为我们做些贡献，这里有我们的计划。一个简短的 todo_ 列表。
-
-    .. include:: ../../TODO.rst
+如果您想为我们做些贡献，请查看 GitHub_ 上的 issue 列表。
 
 
 .. _GitHub: https://github.com/kennethreitz/python-guide/
-.. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst

TODO.rst

@@ -0,0 +1,13 @@
+[project]
+name = "python-guide-cn"
+version = "0.0.0"
+description = "Chinese translation of The Hitchhiker's Guide to Python"
+requires-python = ">=3.12"
+dependencies = [
+    "sphinx>=7.4,<8",
+    "sphinx-sitemap>=2.9,<3",
+    "sphinxcontrib-websupport>=2,<3",
+]
+
+[tool.uv]
+package = false