Pyhton项目的文档有好多种风格,例如Scrapy这种,比较干净简洁;也比如Flask这种更加素雅、简单;当然还有Python的官方文档
最近想翻译的一个项目文档dota2api,他们的项目开源在Github
我的想法是fork一下,增加相应的中文文档,然后提个pull request。问题是不知道这种文档的组织结构,这种类似Scrapy的文档风格是否用了一些框架。
请教各位,该如何下手?
光阴似箭催人老,日月如移越少年。
看了下他们的代码,文档用的是Sphinx引擎,不知楼主用过木有,如果没用过,可以
pip install sphinx sphinx-quickstart xxx
试一下。
翻译的顺序是:
先翻译
完成后开issue与作者沟通,约定文档规范
如果作者希望合并到主项目,fork,修改,提PR
作者希望新开个文档 repo, fork,重命名,替换文档内容,部署到RTD
作者不希望你翻译,额,应该不会有这么傲娇的作者吧......
看了下他们的代码,文档用的是Sphinx引擎,不知楼主用过木有,如果没用过,可以
试一下。
翻译的顺序是:
先翻译
完成后开issue与作者沟通,约定文档规范
如果作者希望合并到主项目,fork,修改,提PR
作者希望新开个文档 repo, fork,重命名,替换文档内容,部署到RTD
作者不希望你翻译,额,应该不会有这么傲娇的作者吧......