引用Python文檔字符串中的參數

Question

我使用Sphinx和autodocs功能來確保在我們的項目中有良好的文檔。

所以我熟悉info field lists，我熟悉在我們的文檔中使用cross-referencing。

但是，當爲某個方法或函數編寫docstring時，我發現在文本中引用它們的參數很有用。但似乎沒有一個結構化的方式來做到這一點。

1. 我們可以說例如

   Use ``name`` to set the username 
   

   但沒有結構，需要你記住你用什麼樣的風格爲，如果你改變風格，你必須追捕和殺死所有不正確的樣式。

2. ：PARAM：沒有一個信息字段列表之外的工作，所以你不能寫

   Use :param:`name` to set the username 
   

3. 我已經看到了一些項目中使用：PARM：但不記錄，並沒有按似乎沒有用。所以他們必須有一些定製

4. 我可以使用generic_roles，但似乎像我一樣圍繞着我確信其他人遇到的問題工作。

所以希望我錯過了一些非常明顯的事情。

Answer 1

您可以使用autodoc-process-docstring編寫自己的擴展名 - 它非常簡單。

擴展搜索:param:並將其替換爲您選擇的樣式。