為什麼Python第三方庫的document看起來很統一?

用Python的時候發現的,基本上字體,排版是一樣的,而且右下角都提供PDF版下載,連按鈕都是一樣的。雖然網站不一樣,但是會給人很統一的感覺。而之前看C++的第三方庫(不考慮qt,msdn那種的)給人的感覺是網站很老(感覺都沒有用CSS那種樣子,略誇張),而且document寫的也很亂。這是個例嗎?Python的document是有統一規定嗎?


Python自帶了一個寫文檔的工具,叫做 Sphinx ,這個工具很好用,你看到的很多Python模塊都是用這個工具生成的,所以看上去整體都是差不多的。sphinx支持多種主題。

還有另一個網站叫http://readthedocs.org/ ,這個網站可以免費託管用sphinx寫的文檔,而這個網站呢,默認使用的是一個叫 sphinx_rtd_theme的主題。由於這個網站託管sphinx文檔很方便,所以很多模塊選擇把文檔託管在這裡,進一步導致文檔的主題都差不多。


除了有好的文檔工具外,python本身代碼即文檔的理念也做的很好,docstring也非常方便,不懂的地方直接help()一下就行。


歸功於sphinx


推薦閱讀:

Python現在用3.X的好不好?2.X我在win10打開不了IDLE又是什麼問題?
Python訪問網頁報錯,ValueError: unknown url type,求問什麼原因?
Python的from import和import的區別?
python有什麼類似特性(或者是解釋型語言特性)?
新手遇到笨辦法學python第13題?

TAG:Python | Python3x | Python庫 |