【问题标题】:sphinx not linking to multiprocessing.Value狮身人面像没有链接到 multiprocessing.Value
【发布时间】:2014-04-13 18:04:41
【问题描述】:

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

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

:type param1::class:~multiprocessing.Queue

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

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

【问题讨论】:

    标签: python documentation python-sphinx cross-reference


    【解决方案1】:

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

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

    【讨论】:

    • 我明白了,是的。我想我对什么是方法感到困惑。 :meth: 用于对象的方法,多处理不是对象 :) 谢谢。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-11-25
    相关资源
    最近更新 更多