我在很大的項目中有很多Python（2.x）源文件。他們中的大多數都有很好的文檔記錄 - 在文檔中，或在類/方法開始時的註釋。用於從源文件創建文檔的Python解決方案
我所尋找的是一個能夠讀取這些文件並從中創建文檔的工具 - 最好的方法是使用類繼承，方法名稱和參數以及提取的文檔字符串/註釋的內容。輸出應該是一個很好的文檔，可以作爲技術文檔打印並與項目一起交付。
我搜索了一下，發現一個HappyDoc項目，但它看起來很老，並且不活躍。
您是否使用過這樣的工具，並且能夠提出足夠強大的功能來完成此任務，並且仍然夠簡單，因此設置它不會需要一整天？
有三種工具來雷：
獅身人面像很可能是首先看最好的一個，它的一個由核心Python團隊用於python文檔。
我使用DoxyGen並創建了一個ant文件，可以從我的IDE Eclipse PyDev中運行以生成文檔。它以HTML（和CHM），PDF和Word格式生成文檔。我還安裝了GraphViz，以便使用類和繼承的圖形化圖表增強文檔，相當不錯。
DoxyGen解析我所需要的源代碼。其他一些文檔生成器通過運行代碼來使用自省，但這不是我想要的。
這是我的10美分小費。
獅身人面像結合內置的autodoc和inheritance_diagram擴展應該能夠做你想做的。目前您必須手動命名每個模塊，但autodoc會計算出其餘的。請注意，您必須在所有文檔字符串中使用Sphinx的語法才能使其工作。
+1大家似乎都推薦獅身人面像。我一直在考慮自己的需求，但是我一直無法弄清楚如何真正使用它，所以可能會涉及一條學習曲線： -/ – 2010-07-07 06:32:59
我認爲學習曲線非常分鐘。運行'sphinx-quickstart'，回答問題，並開始寫作。 – Philipp 2010-07-07 06:56:58