顯示*僅*文檔字符串獅身人面像文檔

Question

獅身人面像有一個叫做automethod功能，它可以提取方法的文檔字符串的文件，並嵌入了入文檔。但它不僅嵌入了文檔字符串，還嵌入了方法簽名（名稱+參數）。我如何嵌入只有文檔字符串（不包括方法簽名）？

裁判：http://sphinx.pocoo.org/ext/autodoc.html

Answer 1

我想你要找的是什麼：

from sphinx.ext import autodoc 

class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): 
    def format_args(self): 
    return None 

autodoc.add_documenter(DocsonlyMethodDocumenter) 

每the current sources這應該允許覆蓋哪些類是負責記錄的方法（舊版本的add_documenter禁止這樣的覆蓋，但現在他們明確允許）。有format_args返回沒有，當然，在autodoc中記錄的方式說「不要打擾簽名」。

我認爲這是執行此任務的清潔，架構方式，並且，正因爲如此，最好的Monkeypatching替代品。如果你需要忍受一些舊版本的sphinx但是你可能確實有猴補丁（autodoc.MethodDocumenter.format_args=lambda _:None - 伊克 - ！），但我會建議升級sphinx到當前版本的更好的方法，如果在特定的部署在所有可行的。