2014-04-13 49 views
1

我正在使用Sphinx來記錄我正在處理的一個小項目。我正在使用Python多處理Queue和Value結構,並且我希望Sphinx鏈接到正確的文檔。我對使用獅身人面像很陌生,所以我很難理解我可能做錯了什麼。獅身人面像沒有鏈接到multiprocessing.Value

我有我的代碼中的這兩行,到隊列的鏈接正常工作,並鏈接here正如所料。但第二個,應該鏈接here不。

:類型參數1:類:~multiprocessing.Queue

:類型參數2:方法:~multiprocessing.Value(還與嘗試:等級:,:功能:,:屬性:)

這兩者都是在函數的文檔字符串,並且sphinx正如我所期望的正確生成其餘部分,唯一的問題是它沒有鏈接到multiprocessing.Value文檔。

回答

1

multiprocessing.Value是一個函數,適當的交叉引用角色是:func:。下面的標記應該適合你:

:type param2: :func:`~multiprocessing.Value` 
+0

我看,是的,工作。我想我對什麼是方法感到困惑。 :meth:用於對象的方法,多處理不是對象:)謝謝。 – user2812716