Skip to content

Commit 63cc98c

Browse files
author
jzlin
committed
add README.md, README_ORI.md
1 parent d4d93de commit 63cc98c

File tree

2 files changed

+136
-130
lines changed

2 files changed

+136
-130
lines changed

README.md

Lines changed: 5 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,6 @@
1+
# python3 cookbook
2+
- original [README.md](./README_ORI.md)
13

2-
[![GitHub issues](https://img.shields.io/github/issues/yidao620c/python3-cookbook.svg)](https://github.com/yidao620c/python3-cookbook/issues)
3-
[![License][licensesvg]][license]
4-
[![Github downloads](https://img.shields.io/github/downloads/yidao620c/python3-cookbook/total.svg)](https://github.com/yidao620c/python3-cookbook/releases/latest)
5-
[![GitHub release](https://img.shields.io/github/release/yidao620c/python3-cookbook.svg)](https://github.com/yidao620c/python3-cookbook/releases)
6-
7-
8-
# 《Python Cookbook》 3rd Edition 翻译
9-
10-
《Python Cookbook》3rd 中文版3.0.0正式发布啦 ^_^! ——2017/12/07
11-
12-
在线阅读地址:<http://python3-cookbook.readthedocs.org/zh_CN/latest/>
13-
14-
最新版(3.0.0)下载
15-
16-
* 中文简体版PDF下载地址:<https://pan.baidu.com/s/1pL1cI9d>
17-
* 中文繁体版PDF下载地址:<https://pan.baidu.com/s/1qX97VJI>
18-
19-
20-
## 译者的话
21-
22-
人生苦短,我用Python!
23-
24-
译者一直坚持使用Python3,因为它代表了Python的未来。虽然向后兼容是它的硬伤,但是这个局面迟早会改变的,
25-
而且Python3的未来需要每个人的帮助和支持。
26-
目前市面上的教程书籍,网上的手册大部分基本都是2.x系列的,专门基于3.x系列的书籍少的可怜。
27-
28-
最近看到一本《Python Cookbook》3rd Edition,完全基于Python3,写的也很不错。
29-
为了Python3的普及,我也不自量力,想做点什么事情。于是乎,就有了翻译这本书的冲动了!
30-
这不是一项轻松的工作,却是一件值得做的工作:不仅方便了别人,而且对自己翻译能力也是一种锻炼和提升。
31-
32-
译者会坚持对自己每一句的翻译负责,力求高质量。但受能力限制,也难免有疏漏或者表意不当的地方。
33-
如果译文中有什么错漏的地方请大家见谅,也欢迎大家随时指正。
34-
35-
目前已经正式完成了整本书的翻译工作,历时2年,不管怎样还是坚持下来了。现在共享给python社区。
36-
37-
**捐助渠道已开通,如有意向请点击[【微信二维码】](qcode.jpg) 捐赠。**
38-
39-
40-
## 项目说明
41-
42-
* 所有文档均使用reStructuredText编辑,参考 [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
43-
* 当前文档生成托管在 [readthedocs](https://readthedocs.org/)
44-
* 生成的文档预览地址: [python3-cookbook](http://python3-cookbook.readthedocs.org/zh_CN/latest/)
45-
* 使用了python官方文档主题 [sphinx-rtd-theme](https://github.com/snide/sphinx_rtd_theme) ,也是默认的主题default.
46-
* 书中所有代码均在python 3.6版本下面运行通过,所有源码放在cookbook包下面
47-
48-
```
49-
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
50-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
51-
52-
if not on_rtd: # only import and set the theme if we're building docs locally
53-
import sphinx_rtd_theme
54-
html_theme = 'sphinx_rtd_theme'
55-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
56-
57-
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
58-
```
59-
60-
61-
## 其他贡献者
62-
63-
排名不分先后:
64-
65-
1. Yu Longjun (https://github.com/yulongjun)
66-
1. tylinux (https://github.com/tylinux)
67-
1. Kevin Guan (https://github.com/K-Guan)
68-
1. littlezz (https://github.com/littlezz)
69-
1. cclauss (https://github.com/cclauss)
70-
1. Yan Zhang (https://github.com/Eskibear)
71-
1. xiuyanduan (https://github.com/xiuyanduan)
72-
1. FPlust (https://github.com/fplust)
73-
1. lambdaplus (https://github.com/lambdaplus)
74-
1. Tony Yang ([email protected])
75-
76-
[更多贡献者](https://github.com/yidao620c/python3-cookbook/graphs/contributors)
77-
78-
-----------------------------------------------------
79-
80-
## 关于源码生成PDF文件
81-
82-
有网友提问怎样通过源码生成PDF文件,由于这个步骤介绍有点长,不适合放在README里面,
83-
我专门写了篇博客专门介绍怎样通过ReadtheDocs托管文档,怎样自己生成PDF文件,大家可以参考一下。
84-
85-
<https://www.xncoding.com/2017/01/22/fullstack/readthedoc.html>
86-
87-
另外关于生成的PDF文件中会自动生成标题编号的问题,有热心网友 [CarlKing5019](https://github.com/CarlKing5019)提出了解决方案,
88-
请参考issues108:
89-
90-
<https://github.com/yidao620c/python3-cookbook/issues/108>
91-
92-
再次感谢每一位贡献者。
93-
94-
-----------------------------------------------------
95-
96-
## How to Contribute
97-
98-
You are welcome to contribute to the project as follow
99-
100-
* fork project and commit pull requests
101-
* add/edit wiki
102-
* report/fix issue
103-
* code review
104-
* commit new feature
105-
* add testcase
106-
107-
Meanwhile you'd better follow the rules below
108-
109-
* It's *NOT* recommended to submit a pull request directly to `master` branch. `develop` branch is more appropriate
110-
* Follow common Python coding conventions
111-
* Add the following [license] in each source file
112-
113-
## License
114-
115-
(The Apache License)
116-
117-
Copyright (c) 2014-2018 [Xiong Neng](<https://www.xncoding.com/>) and other contributors
118-
119-
Licensed under the Apache License, Version 2.0 (the "License");
120-
you may not use this file except in compliance with the License. You may obtain a copy of the License at
121-
122-
http://www.apache.org/licenses/LICENSE-2.0
123-
124-
Unless required by applicable law or agreed to in writing,
125-
software distributed under the License is distributed on an "AS IS" BASIS,
126-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
127-
See the License for the specific language governing permissions and limitations under the License.
128-
129-
130-
[licensesvg]: https://img.shields.io/hexpm/l/plug.svg
131-
[license]: http://www.apache.org/licenses/LICENSE-2.0
4+
## Usage
5+
- This project is used to index and search when coding in vim. (Working ...)
6+
- 该项目用于索引和在vim编程时提供实时提示 (进行时 ...)

README_ORI.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
2+
[![GitHub issues](https://img.shields.io/github/issues/yidao620c/python3-cookbook.svg)](https://github.com/yidao620c/python3-cookbook/issues)
3+
[![License][licensesvg]][license]
4+
[![Github downloads](https://img.shields.io/github/downloads/yidao620c/python3-cookbook/total.svg)](https://github.com/yidao620c/python3-cookbook/releases/latest)
5+
[![GitHub release](https://img.shields.io/github/release/yidao620c/python3-cookbook.svg)](https://github.com/yidao620c/python3-cookbook/releases)
6+
7+
8+
# 《Python Cookbook》 3rd Edition 翻译
9+
10+
《Python Cookbook》3rd 中文版3.0.0正式发布啦 ^_^! ——2017/12/07
11+
12+
在线阅读地址:<http://python3-cookbook.readthedocs.org/zh_CN/latest/>
13+
14+
最新版(3.0.0)下载
15+
16+
* 中文简体版PDF下载地址:<https://pan.baidu.com/s/1pL1cI9d>
17+
* 中文繁体版PDF下载地址:<https://pan.baidu.com/s/1qX97VJI>
18+
19+
20+
## 译者的话
21+
22+
人生苦短,我用Python!
23+
24+
译者一直坚持使用Python3,因为它代表了Python的未来。虽然向后兼容是它的硬伤,但是这个局面迟早会改变的,
25+
而且Python3的未来需要每个人的帮助和支持。
26+
目前市面上的教程书籍,网上的手册大部分基本都是2.x系列的,专门基于3.x系列的书籍少的可怜。
27+
28+
最近看到一本《Python Cookbook》3rd Edition,完全基于Python3,写的也很不错。
29+
为了Python3的普及,我也不自量力,想做点什么事情。于是乎,就有了翻译这本书的冲动了!
30+
这不是一项轻松的工作,却是一件值得做的工作:不仅方便了别人,而且对自己翻译能力也是一种锻炼和提升。
31+
32+
译者会坚持对自己每一句的翻译负责,力求高质量。但受能力限制,也难免有疏漏或者表意不当的地方。
33+
如果译文中有什么错漏的地方请大家见谅,也欢迎大家随时指正。
34+
35+
目前已经正式完成了整本书的翻译工作,历时2年,不管怎样还是坚持下来了。现在共享给python社区。
36+
37+
**捐助渠道已开通,如有意向请点击[【微信二维码】](qcode.jpg) 捐赠。**
38+
39+
40+
## 项目说明
41+
42+
* 所有文档均使用reStructuredText编辑,参考 [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
43+
* 当前文档生成托管在 [readthedocs](https://readthedocs.org/)
44+
* 生成的文档预览地址: [python3-cookbook](http://python3-cookbook.readthedocs.org/zh_CN/latest/)
45+
* 使用了python官方文档主题 [sphinx-rtd-theme](https://github.com/snide/sphinx_rtd_theme) ,也是默认的主题default.
46+
* 书中所有代码均在python 3.6版本下面运行通过,所有源码放在cookbook包下面
47+
48+
```
49+
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
50+
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
51+
52+
if not on_rtd: # only import and set the theme if we're building docs locally
53+
import sphinx_rtd_theme
54+
html_theme = 'sphinx_rtd_theme'
55+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
56+
57+
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
58+
```
59+
60+
61+
## 其他贡献者
62+
63+
排名不分先后:
64+
65+
1. Yu Longjun (https://github.com/yulongjun)
66+
1. tylinux (https://github.com/tylinux)
67+
1. Kevin Guan (https://github.com/K-Guan)
68+
1. littlezz (https://github.com/littlezz)
69+
1. cclauss (https://github.com/cclauss)
70+
1. Yan Zhang (https://github.com/Eskibear)
71+
1. xiuyanduan (https://github.com/xiuyanduan)
72+
1. FPlust (https://github.com/fplust)
73+
1. lambdaplus (https://github.com/lambdaplus)
74+
1. Tony Yang ([email protected])
75+
76+
[更多贡献者](https://github.com/yidao620c/python3-cookbook/graphs/contributors)
77+
78+
-----------------------------------------------------
79+
80+
## 关于源码生成PDF文件
81+
82+
有网友提问怎样通过源码生成PDF文件,由于这个步骤介绍有点长,不适合放在README里面,
83+
我专门写了篇博客专门介绍怎样通过ReadtheDocs托管文档,怎样自己生成PDF文件,大家可以参考一下。
84+
85+
<https://www.xncoding.com/2017/01/22/fullstack/readthedoc.html>
86+
87+
另外关于生成的PDF文件中会自动生成标题编号的问题,有热心网友 [CarlKing5019](https://github.com/CarlKing5019)提出了解决方案,
88+
请参考issues108:
89+
90+
<https://github.com/yidao620c/python3-cookbook/issues/108>
91+
92+
再次感谢每一位贡献者。
93+
94+
-----------------------------------------------------
95+
96+
## How to Contribute
97+
98+
You are welcome to contribute to the project as follow
99+
100+
* fork project and commit pull requests
101+
* add/edit wiki
102+
* report/fix issue
103+
* code review
104+
* commit new feature
105+
* add testcase
106+
107+
Meanwhile you'd better follow the rules below
108+
109+
* It's *NOT* recommended to submit a pull request directly to `master` branch. `develop` branch is more appropriate
110+
* Follow common Python coding conventions
111+
* Add the following [license] in each source file
112+
113+
## License
114+
115+
(The Apache License)
116+
117+
Copyright (c) 2014-2018 [Xiong Neng](<https://www.xncoding.com/>) and other contributors
118+
119+
Licensed under the Apache License, Version 2.0 (the "License");
120+
you may not use this file except in compliance with the License. You may obtain a copy of the License at
121+
122+
http://www.apache.org/licenses/LICENSE-2.0
123+
124+
Unless required by applicable law or agreed to in writing,
125+
software distributed under the License is distributed on an "AS IS" BASIS,
126+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
127+
See the License for the specific language governing permissions and limitations under the License.
128+
129+
130+
[licensesvg]: https://img.shields.io/hexpm/l/plug.svg
131+
[license]: http://www.apache.org/licenses/LICENSE-2.0

0 commit comments

Comments
 (0)