Sphinx：記錄與參數相同的屬性

Question

我想用numpy樣式的文檔字符串來記錄類似這樣的內容。

​​

屬性和參數是相同的。我可以/應該避免重複嗎？

Answer 1

對於像你這樣的情況，輸入參數和屬性完全相同的引用，我只會記錄該屬性。任何熟悉Python的人都會立即知道參數是。

對於更復雜的情況，我更喜歡記錄類本身和__init__方法。在這種情況下，參數描述將進入__init__的文檔字符串。

由於您似乎在使用autodoc擴展名，因此您需要在autoclass指令中添加:special-members: __init__選項。如果您想記錄其他特殊成員，則可以將它們添加到選項的參數列表中。您也可以完全忽略參數:special-members:以記錄所有魔法屬性，但可能包含您不想要的內容，如__weakref__。