python - sphinx 未链接到 multiprocessing.Value

Question

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

我的代码中有这两行，队列的链接工作正常，链接 here正如预期的那样。但第二个应该链接 here没有。

:type param1: :class:~multiprocessing.Queue

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

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

Answer 1

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

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