MrKiven / PyZh

关于

利用readthedocs的Python技术文章的翻译和收集。

订阅

RSS: https://pyzh.readthedocs.org/en/latest/rss.xml

Online: https://pyzh.readthedocs.org/en/latest/

约定

• 文件名必须是英文。一个文章的多个文件如下命名:

  xxxx-Part1.rst, xxxx-Part2.rst ..
  

• 文第一行注明日期:

  :Date: 2013-04-15 22:00:00
  

• 翻译的文章，需要注明原文链接

请Fork一起编写！

1. 初始化环境:

   git clone https://github.com/hit9/PyZh
   cd PyZh
   git submodule init & git submodule update
   virtualenv venv
   source <env-path>/bin/activate
   pip install -r requirements.pip
   

2. 编写文章:

   vim docs/xxxxx.rst
   

3. 编译预览:

   make doc
   cd _build/html
   python -m SimpleHTTPServer
   

   打开 http://localhost:8000 预览

4. 更新Readthedocs文档:

   push上去到Github, 然后到https://readthedocs.org/projects/pyzh build下即可

RST

RST文档的语法: https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst

Example可以看项目中其它文章的源码