在 Sphinx 中避免來自父級的文檔字符串

Question

我將 Sphinx 用於自動文檔，但我發現它默認將父類文檔字符串附加到我的文檔字符串的方式很煩人。

結果是，對於從unittest.TestCase繼承的每個記錄的測試類，我得到文檔字符串“創建一個在執行時將使用命名測試方法的類的實例。如果該實例沒有一個方法，則引發 ValueError指定的名稱。” 附加。 所以這兩句話一遍又一遍地亂扔我的測試文檔。

如何阻止 Sphinx 從父級中提取文檔字符串？

Answer 1

有一個設置：

autodoc_inherit_docstrings

此值控制文檔字符串繼承。 如果設置為True類或方法的文檔字符串，如果沒有明確設置，則是繼承形式（原文如此）父母。

默認值為True 。

1.7 版中的新功能。

盡管小心使用 - 此設置似乎破壞了我在文檔字符串中調用的指令。