1

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

我的代码中有这两行,指向 Queue 的链接正常工作,并按预期链接到此处。但是第二个,应该链接在这里没有。

:类型参数1::类:~multiprocessing.Queue

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

这两个都在函数的文档字符串中,并且 sphinx 正确地生成了它的其余部分,唯一的问题是它没有链接到 multiprocessing.Value 文档。

4

1 回答 1

1

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

:type param2: :func:`~multiprocessing.Value`
于 2014-04-15T16:48:21.160 回答