做Django开发, 经常需要查看docs, 这就需要我到官网上去浏览. 如果遇到网络不好, 页面打开十分缓慢, 非常痛苦.
其实, 在django的svn repository里, 有相应的docs, 不过是txt格式的. 如果浏览这个, 当然会非常的别扭.
今天看到, django对docs进行了重构, 现在大家可以将这些文件下载到本地, 然后进行编译, 生成相应的文档, 浏览起来会非常方便, 舒服.
好, 我们简单的看一看该如何操作:
1. 从svn库中checkout:
svn co http://code.djangoproject.com/svn/django/trunk/docs/ django_docs
这样, 在当前目录下就会有了django_docs了. 进去看一看, 恩, 重构后结构果然清晰多了, 过去是一股脑将所有的文件放在一起, 现在是分门别类, 不错.
2. 安装Sphinx:
easy_install Sphinx
当然前提是python中已经安装了easy_install, 如果没有, 大家google一下, 非常容易.
熟悉python的朋友应该知道, Sphinx是非常好的一个工具, 可以将简单文本格式转换为html格式, 当然, 文本内容需要按照Sphinx的语法进行编写. Python现在的在线documents就是使用Sphinx进行编译的.感兴趣的朋友可以到
Sphinx了解更多内容.
3. 编译:
make html
这里make提供了很多种格式, 因为我们只需要html, 所以加上这个选项就行了.
到这里, 就完成了django_docs的编译工作, 在django_docs/_build/html下就是编译的结果. 重构后的文档的css也有了新的变化, 现在的非常像django_book的样式.
OK, 以后我们就可以在本地进行文档的阅读了, 相信会给开发带来事半功倍的效果.
这里我附上一份我编译好的, 供大家下载.
django_docs