從python源代碼生成markdown或reStructuredText文檔

Question

我一直在使用pydoc生成文檔，但.html在github中看起來不太好。

現在人們用什麼來從python源代碼生成markdown或RST？我查看了一些here提到的軟件包，但沒有任何成功。

Answer 1

嘗試sphinx

• 輸出格式：HTML（包括Windows HTML幫助），乳膠（用於 可打印的PDF版本），EPUB，Texinfo的，手冊頁，純文本，列表項
• 廣泛的交叉引用：語義標記和自動鏈接爲 函數，類，引文，詞彙表術語和 信息類似件

• 層次結構：一個文件的簡單的定義樹，自動鏈接到兄弟姐妹，父母和子女

• 自動指數：一般指數以及特定語言的 模塊指數

• 代碼處理：使用 Pygments來做熒光筆擴展自動突出顯示：自動的代碼段， 夾雜Python模塊（API文檔）文檔字符串，並檢測更

• 供稿擴展：超過50個擴展貢獻的用戶 在第二存儲庫;其中大部分可從PyPI安裝