?????? 做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