如何用sphinx-apidoc文檔化Python函數參數

Question

我正在清理Python代碼文檔，並決定使用sphinx-doc，因爲它看起來不錯。我喜歡我怎麼能引用其他類和方法與像標籤：

:class:`mymodule.MyClass` About my class. 
:meth:`mymodule.MyClass.myfunction` And my cool function 

我想弄清楚，雖然如何在函數參數名的文件，因此，如果我有這樣一個功能：

def do_this(parameter1, parameter2): 
    """ 
    I can describe do_this. 

    :something?:`parameter1` And then describe the parameter. 

    """ 

這樣做的最佳做法是什麼？

更新：

正確的語法是：

def do_this(parameter1, parameter2): 
    """ 
    I can describe do_this. 

    :something parameter1: And then describe the variable 
    """ 

Answer 1

通常 「函數變量」 被稱爲參數）。

它記錄在這裏：http://sphinx.pocoo.org/domains.html#signatures

答案是:param ________

編輯聲明：我從來沒有使用過或聽說過獅身人面像的...這篇文章主要是一個「去搜一下字「。希望它有幫助。

Answer 2

添加這個答案鞏固選項：

pydoc是基本不使用特殊格式

epydoc使用格式 '@param VAR：'

Doxygen是面向更大範圍的語言

Sphinx使用格式'：param type var：'。另見more examples。這被用來創建Python 3.5 documentation。