?????? 做Django開發(fā), 經(jīng)常需要查看docs, 這就需要我到官網(wǎng)上去瀏覽. 如果遇到網(wǎng)絡(luò)不好, 頁面打開十分緩慢, 非常痛苦.
?????? 其實(shí), 在django的svn repository里, 有相應(yīng)的docs, 不過是txt格式的. 如果瀏覽這個(gè), 當(dāng)然會非常的別扭.
?????? 今天看到, django對docs進(jìn)行了重構(gòu), 現(xiàn)在大家可以將這些文件下載到本地, 然后進(jìn)行編譯, 生成相應(yīng)的文檔, 瀏覽起來會非常方便, 舒服.
?????? 好, 我們簡單的看一看該如何操作:
1. 從svn庫中checkout:
svn?co?http://code.djangoproject.com/svn/django/trunk/docs/?django_docs
?????? 這樣, 在當(dāng)前目錄下就會有了django_docs了. 進(jìn)去看一看, 恩, 重構(gòu)后結(jié)構(gòu)果然清晰多了,? 過去是一股腦將所有的文件放在一起, 現(xiàn)在是分門別類, 不錯(cuò).
2. 安裝Sphinx:
easy_install?Sphinx
??????? 當(dāng)然前提是python中已經(jīng)安裝了easy_install, 如果沒有, 大家google一下, 非常容易.
??????? 熟悉python的朋友應(yīng)該知道, Sphinx是非常好的一個(gè)工具, 可以將簡單文本格式轉(zhuǎn)換為html格式, 當(dāng)然, 文本內(nèi)容需要按照Sphinx的語法進(jìn)行編寫. Python現(xiàn)在的在線documents就是使用Sphinx進(jìn)行編譯的.感興趣的朋友可以到
Sphinx了解更多內(nèi)容.
3. 編譯:
make?html
??????? 這里make提供了很多種格式, 因?yàn)槲覀冎恍枰猦tml, 所以加上這個(gè)選項(xiàng)就行了.
??????? 到這里, 就完成了django_docs的編譯工作, 在django_docs/_build/html下就是編譯的結(jié)果. 重構(gòu)后的文檔的css也有了新的變化, 現(xiàn)在的非常像django_book的樣式.
??????? OK, 以后我們就可以在本地進(jìn)行文檔的閱讀了, 相信會給開發(fā)帶來事半功倍的效果.
???????
??????? 這里我附上一份我編譯好的, 供大家下載.
django_docs