sphinx没有链接到multiprocessing.Value

时间:2014-04-13 18:04:42

标签: python python-sphinx

我正在使用Sphinx来记录我正在进行的一个小项目。我正在使用Python多处理队列和值构造,我希望Sphinx链接到正确的文档。我对使用Sphinx很陌生,所以我无法理解我可能做错了什么。

我的代码中有这两行,Queue的链接正常工作,链接here正如预期的那样。但是第二个,应该链接here不会。

:输入param1 :: class:~multiprocessing.Queue

:输入param2 :: method:~multiprocessing.Value(也试过:class:,:function:,:attribute:)

这两个都在函数的docstring中,并且sphinx正如我所期望的那样正确生成其余部分,唯一的问题是它不能链接到multiprocessing.Value文档。

1 个答案:

答案 0 :(得分:1)

multiprocessing.Value是一个函数,正确的交叉引用角色是:func:。以下标记适用于您:

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