生成一份本地的Django文档

我所知,使用Django的开发人员对于Django的文档都是非常满意的。但是使用起来有一个缺点,就是“必须”在线翻阅。这对于没有网络或者是网络速度烂如我公司这般的情况来说是相当不便的。那么,怎么办呢?其实,如果你试过通过svn获取django代码的话,应该会看到,checkout出来的内容中有一个docs的目录,我们需要的东西其实就在里面。

由于一般使用的django版本都是正式发行版,所以从trunk获取文档一般都不是最合适的。比如我使用的是1.1.1的版本,那么就应该使用如下命令

svn co http://code.djangoproject.com/svn/django/tags/releases/1.1.1/docs django-docs

来获得相应版本的文档。如果你使用了其他版本,你可以到Django Code上去查看相应的文档位置。

在获得文档源码之后,我们还需要安装sphinx来继续余下的翻译过程,在Archlinux上执行

sudo pacman -S python-sphinx

安装完毕后就简单了,进入刚刚checkout出来的django-docs目录,执行

make html

就可以在_build目录下生成一份html的文档。当然你也可以生成latex等格式,这个就萝卜青菜了。

为了方便诸位懒得执行上述步骤的童鞋,就顺道上传了一份1.1.1的文档,民那可以到这个地址下载。

对“生成一份本地的Django文档”的1条评论

  1. Avatar

    thank u

发表评论

评论备注:

  1. 留言时的头像是Gravatar提供的服务。
  2. By submitting a comment here you grant this site a perpetual license to reproduce your words and name/web site in attribution. So, you don't fully own your words, so to speak.