下面是通過 mkdocs 運行它產(chǎn)生 readthedocs 主題頁面后的最終結(jié)果(不包括函數(shù)注釋)的示例。
我相信你已經(jīng)知道,使用這些機制自動生成文檔,會生成完整、精確和最新的模塊信息,這些信息在你編寫代碼的時候可以進行維護和編寫,且操作簡單 。我強烈建議每個人都試一試。
在結(jié)束之前,我想再補充一點,mkdocs 并不是唯一的文檔包,還有其他一些使用廣泛的系統(tǒng),如 Sphinx(mkdocs 基于此開發(fā) )和 Doxygen,他們都能實現(xiàn)我們以上討論的事項。然而,我比較通過練習(xí)來學(xué)習(xí)和了解更多關(guān)于 Python 內(nèi)部機制和其隨附的工具。