Skip to content

Commit 194d1e5

Browse files
committed
update readme
1 parent c842b10 commit 194d1e5

File tree

1 file changed

+33
-57
lines changed

1 file changed

+33
-57
lines changed

README.rst renamed to README.md

Lines changed: 33 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,27 @@
1-
=========================================================
2-
《Python Cookbook》 3rd Edition 翻译
3-
=========================================================
41

5-
-------------------------------------------------------------
2+
# 《Python Cookbook》 3rd Edition 翻译
63

74
《Python Cookbook》3rd 中文版3.0.0正式发布啦 ^_^! ——2017/12/07
85

9-
在线阅读地址: http://python3-cookbook.readthedocs.org/zh_CN/latest/
6+
在线阅读地址:<http://python3-cookbook.readthedocs.org/zh_CN/latest/>
107

118
最新版(3.0.0)下载
129

13-
* 中文简体版PDF下载地址: https://pan.baidu.com/s/1pL1cI9d
14-
* 中文繁体版PDF下载地址: https://pan.baidu.com/s/1qX97VJI
10+
* 中文简体版PDF下载地址:<https://pan.baidu.com/s/1pL1cI9d>
11+
* 中文繁体版PDF下载地址:<https://pan.baidu.com/s/1qX97VJI>
1512

1613
-------------------------------------------------------------
1714

1815
旧版本(2.0.0)下载
1916

2017
《Python Cookbook》3rd 中文版2.0.0 ——2016/03/31
2118

22-
* 中文简体版PDF下载地址: http://pan.baidu.com/s/1i4Jypff
23-
* 中文繁体版PDF下载地址: http://pan.baidu.com/s/1i5k2CjN
19+
* 中文简体版PDF下载地址:<http://pan.baidu.com/s/1i4Jypff>
20+
* 中文繁体版PDF下载地址:<http://pan.baidu.com/s/1i5k2CjN>
2421

25-
-------------------------------------------------------------
2622

27-
++++++++++++++++
28-
译者的话
29-
++++++++++++++++
23+
## 译者的话
24+
3025
人生苦短,我用Python!
3126

3227
译者一直坚持使用Python3,因为它代表了Python的未来。虽然向后兼容是它的硬伤,但是这个局面迟早会改变的,
@@ -38,69 +33,59 @@
3833
这不是一项轻松的工作,却是一件值得做的工作:不仅方便了别人,而且对自己翻译能力也是一种锻炼和提升。
3934

4035
译者会坚持对自己每一句的翻译负责,力求高质量。但受能力限制,也难免有疏漏或者表意不当的地方。
41-
如果译文中有什么错漏的地方请大家见谅,也欢迎大家随时指正: yidao620@gmail.com
36+
如果译文中有什么错漏的地方请大家见谅,也欢迎大家随时指正
4237

4338
目前已经正式完成了整本书的翻译工作,历时2年,不管怎样还是坚持下来了。现在共享给python社区。
4439

45-
**捐助渠道已开通,如有意向请点击 【微信二维码】_ 捐赠。**
46-
47-
--------------------------------------------------------------
40+
**捐助渠道已开通,如有意向请点击[【微信二维码】](reward.jpg) 捐赠。**
4841

49-
++++++++++++++++
50-
项目说明
51-
++++++++++++++++
52-
#. 所有文档均使用reStructuredText编辑,参考 reStructuredText_
53-
#. 当前文档生成托管在 readthedocs_ 上
54-
#. 生成的文档预览地址: python3-cookbook_
55-
#. 使用了python官方文档主题 sphinx-rtd-theme_ ,也是默认的主题default.
56-
#. 书中所有代码均在python 3.4版本下面运行通过,所有源码放在cookbook包下面
5742

58-
::
43+
## 项目说明
5944

60-
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
61-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
45+
* 所有文档均使用reStructuredText编辑,参考 [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
46+
* 当前文档生成托管在 [readthedocs](https://readthedocs.org/)
47+
* 生成的文档预览地址: [python3-cookbook](http://python3-cookbook.readthedocs.org/zh_CN/latest/)
48+
* 使用了python官方文档主题 [sphinx-rtd-theme](https://github.com/snide/sphinx_rtd_theme) ,也是默认的主题default.
49+
* 书中所有代码均在python 3.4版本下面运行通过,所有源码放在cookbook包下面
6250

63-
if not on_rtd: # only import and set the theme if we're building docs locally
64-
import sphinx_rtd_theme
65-
html_theme = 'sphinx_rtd_theme'
66-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
51+
```
52+
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
53+
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
6754
68-
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
55+
if not on_rtd: # only import and set the theme if we're building docs locally
56+
import sphinx_rtd_theme
57+
html_theme = 'sphinx_rtd_theme'
58+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
6959
60+
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
61+
```
7062

71-
--------------------------------------------------------------
7263

64+
## 其他贡献者
7365

74-
++++++++++++++++
75-
其他贡献者
76-
++++++++++++++++
7766
1. Tony Yang (liuliu036@gmail.com)
7867
2. Yu Longjun (https://github.com/yulongjun)
7968
3. LxMit (https://github.com/LxMit)
8069

8170
-----------------------------------------------------
8271

83-
+++++++++++++++++++++
84-
关于源码生成PDF文件
85-
+++++++++++++++++++++
72+
## 关于源码生成PDF文件
8673

8774
有网友提问怎样通过源码生成PDF文件,由于这个步骤介绍有点长,不适合放在README里面,
8875
我专门写了篇博客专门介绍怎样通过ReadtheDocs托管文档,怎样自己生成PDF文件,大家可以参考一下。
8976

9077
https://www.xncoding.com/2017/01/22/fullstack/readthedoc.html
9178

9279
另外关于生成的PDF文件中会自动生成标题编号的问题,
93-
有热心网友 `CarlKing5019 <https://github.com/CarlKing5019>`_ 提出了解决方案,请参考issues108的解放方案:
80+
有热心网友 [CarlKing5019](https://github.com/CarlKing5019)提出了解决方案,请参考issues108的解放方案:
9481

95-
https://github.com/yidao620c/python3-cookbook/issues/108
82+
<https://github.com/yidao620c/python3-cookbook/issues/108>
9683

9784
再次感谢每一位贡献者。
9885

9986
-----------------------------------------------------
10087

101-
+++++++++++++++++++
102-
How to Contribute
103-
+++++++++++++++++++
88+
## How to Contribute
10489

10590
You are welcome to contribute to the project as follow
10691

@@ -117,13 +102,12 @@ Meanwhile you'd better follow the rules below
117102
* Follow common Python coding conventions
118103
* Add the following [license] in each source file
119104

120-
++++++++++++++++
121-
License
122-
++++++++++++++++
105+
106+
## License
123107

124108
(The Apache License)
125109

126-
Copyright (c) 2014-2015 `Xiong Neng <https://www.xncoding.com/>`_ and other contributors
110+
Copyright (c) 2014-2015 [Xiong Neng](<https://www.xncoding.com/>) and other contributors
127111

128112
Licensed under the Apache License, Version 2.0 (the "License");
129113
you may not use this file except in compliance with the License. You may obtain a copy of the License at
@@ -134,11 +118,3 @@ Unless required by applicable law or agreed to in writing,
134118
software distributed under the License is distributed on an "AS IS" BASIS,
135119
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
136120
See the License for the specific language governing permissions and limitations under the License.
137-
138-
139-
.. _readthedocs: https://readthedocs.org/
140-
.. _sphinx-rtd-theme: https://github.com/snide/sphinx_rtd_theme
141-
.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html
142-
.. _python3-cookbook: http://python3-cookbook.readthedocs.org/zh_CN/latest/
143-
.. _【微信二维码】: https://github.com/yidao620c/python3-cookbook/blob/master/reward.jpg
144-

0 commit comments

Comments
 (0)