Skip to content

Commit 6185631

Browse files
committed
改用 Markdown README 并修复 uv action
1 parent b84aa1a commit 6185631

4 files changed

Lines changed: 64 additions & 88 deletions

File tree

.github/workflows/pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
uses: actions/checkout@v4
2525

2626
- name: Set up uv
27-
uses: astral-sh/setup-uv@v8
27+
uses: astral-sh/setup-uv@v8.1.0
2828

2929
- name: Set up Python
3030
uses: actions/setup-python@v5

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Python最佳实践指南中文版
2+
3+
[![Open Collective 支持者](https://opencollective.com/python-guide-cn/backers/badge.svg)](#支持者)
4+
[![Open Collective 赞助者](https://opencollective.com/python-guide-cn/sponsors/badge.svg)](#赞助者)
5+
6+
![Python 指南配图](https://farm1.staticflickr.com/628/33173824932_58add34581_k_d.jpg)
7+
8+
项目翻译来自 [Hitchhiker's Guide to Python](https://github.com/kennethreitz/python-guide)
9+
10+
文档地址:[Python最佳实践指南中文版](https://prodesire.github.io/Python-Guide-CN/)
11+
12+
本指南目前持续不断地更新与完善。这份主要是自我见解的指南旨在为 Python 初学者和专家提供一个关于 Python 安装、配置和日常使用的最佳实践手册。
13+
14+
主题包括:
15+
16+
- 不同平台和系统上的安装
17+
- Py2app、Py2exe、bbfreeze、pyInstaller
18+
- Pip
19+
- NumPy、SciPy、statpy、pyplot、matplotlib
20+
- Virtualenv
21+
- Fabric
22+
- 优秀的模块推荐,按主题/目的分类
23+
- 在哪些场景下使用哪些模块
24+
- 服务器配置与不同的 Web 框架和工具
25+
- 文档:写文档
26+
- 测试:Jenkins 与 tox 指南
27+
- 如何更方便地通过 `git` 连接 `hg`
28+
29+
## 使用指南
30+
31+
1. 下载 zip 文件或 clone 到本地,并进入到项目根目录。
32+
2. 运行 `make help` 查看可用命令。
33+
3. 运行 `make install` 使用 uv 根据 `pyproject.toml` 创建虚拟环境并安装依赖。
34+
4. 运行 `make html` 构建文档;或运行 `make serve` 构建并启动本地文档网站。
35+
5. `make html` 会在 `docs/_build/html` 中生成 HTML 文件,`make serve` 默认会在 `http://localhost:8005/` 运行文档网站。
36+
37+
## 翻译指南
38+
39+
1.[python-guide](https://github.com/kennethreitz/python-guide) 项目和本项目的 `master` 分支更新。
40+
2. 查看本项目 `diff.txt` 中的当前翻译版本对应的原版提交号,在 `python-guide` 中比对 `master` 分支上最新提交和该提交号的差异,并据此翻译进本项目。
41+
3. 翻译完毕后将 `python-guide``master` 分支上的最新提交号更新入 `diff.txt` 的当前翻译版本对应的原版提交号。
42+
4. 在本项目中提交修改、推送,并发起合并请求。
43+
44+
## 鸣谢
45+
46+
### 贡献者
47+
48+
感谢所有为本项目做出贡献的人。
49+
50+
![贡献者](https://opencollective.com/python-guide-cn/contributors.svg?width=890&button=false)
51+
52+
### 支持者
53+
54+
感谢所有支持者。[成为支持者](https://opencollective.com/python-guide-cn#backer)
55+
56+
[![支持者](https://opencollective.com/python-guide-cn/backers.svg?width=890)](https://opencollective.com/python-guide-cn#backers)
57+
58+
### 赞助者
59+
60+
欢迎赞助本项目。您的 Logo 将显示在这里,并链接到您的网站。[成为赞助者](https://opencollective.com/python-guide-cn#sponsor)
61+
62+
[![赞助者](https://opencollective.com/python-guide-cn/sponsor/0/avatar.svg)](https://opencollective.com/python-guide-cn/sponsor/0/website)

Readme.rst

Lines changed: 0 additions & 87 deletions
This file was deleted.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
name = "python-guide-cn"
33
version = "0.0.0"
44
description = "Chinese translation of The Hitchhiker's Guide to Python"
5+
readme = "README.md"
56
requires-python = ">=3.12"
67
dependencies = [
78
"sphinx>=7.4,<8",

0 commit comments

Comments
 (0)