scrapy中文翻译文档
Switch branches/tags
Nothing to show
Clone or download
Latest commit 5ed032c Oct 16, 2015

README.rst

Scrapy文档快速开始向导

文档地址

文档目前托管在readthedocs。请查看

http://scrapy-chs.readthedocs.org/zh_CN/latest/

Scrapy中文文档翻译计划

本文档由marchtea初始进行翻译。网上也有相应的翻译, 但是大多仅仅翻译了其中的入门教程,并没有完整翻译。

于是这个坑就打开了。

@update 2014/9/21

@update 2014/6/23 经过一段时间的努力,以及给力的小伙伴们,目前scrapy的文档已经翻译的差不多了。目前还未翻译的章节有:

  • topics/selectors.rst
  • topics/spiders.rst
  • topics/api.rst
  • topics/practices.rst
  • topics/loaders.rst
  • topics/request-response.rst
  • versioning.rst
  • contributing.rst(可翻可不翻)

剩余的章节已经翻译完毕。希望各位在查看文档的同时,对于翻译不准确的部分给予反馈(open issue)。感谢各位的支持。

关于版本

scrapy目前最新的发行版是 0.24.4 。这也是能在 pip 上下载到的 最新版本 。另外,其github上的repo也一直在更新。由于第一次进行翻译文档的工作,对版本也不大熟悉,导致有段时间 rtd 上的文档版本是最新的master分支上的文档,和pip上的有所不同。对于给各位造成的困扰表示抱歉。

现在的repo参考了scrapy的repo,由 master分支 , 0.22分支 , 0.24分支 组成。

  • master分支:紧跟着官方的master分支,文档会尽可能的与master分支相同,目前版本(0.25.1)
  • 0.22分支: 为官方的0.22分支文档,尽可能的与0.22分支相同。各位使用最新发行版的请参考本文档。
  • 0.24分支: 为官方的0.24分支文档,尽可以与0.24分支相同。请使用0.24发行版的朋友们参考本文档。

在readthedocs上,默认的文档版本为 0.24 ,以方便大家参考。而使用了官方repo最新的master分支的朋友,可以在readthedocs上修改版本,切换到master版本。

加入我们吧

Scrapy的文档写得很详细,与之带来的就是文档量很大。 仅仅靠我需要很多的时间。希望您能加入这个计划,让翻译更快速。

除此之外,您也可以通过阅读相应的文章,提出翻译错误或者不满意的地方。

  • 欢迎open issue
  • 欢迎加入翻译组

如何翻译

在开始翻译前,请先open issue,说明自己要翻译的章节,大致完成的时间。 之后fork我的repo。

翻译完成前请先在自己的环境中运行

make html

大致浏览一下结果。然后提交pull request。

We need U

本文档提供了编译Scrapy文档的快速入门

环境配置

以下Python库在编译文档时将会被使用:

  • Sphinx
  • docutils
  • jinja

如果您已经安装好setuptools,执行下列命令将会安装全部所需的库 (Sphinx同时依赖了docutils和jinja):

easy_install Sphinx

编译文档

在当前路径下运行下面的命令将编译文档(输出为HTML):

make html

(HTML格式的)文档将被生成在``build/html``路径下.

查看文档

您可以执行下列命令来查看文档:

make htmlview

该命令将会启动您默认的浏览器,并且打开您之前生成的HTML文档的首页

重新开始

执行下列命令来清除生成的文档:

make clean

注意,该命令不会对文档的源文件有任何影响