【问题标题】:Python constant values not detected未检测到 Python 常量值
【发布时间】:2018-11-05 15:03:04
【问题描述】:

我正在尝试使用 sphinx 交叉引用和 intersphinx 来记录我的代码。我可以轻松地创建到其他文档的超链接,但是 Python 应该包含在核心中,并且它的常量值不会被检测到(TrueFalseNone)。

我导入了 interspinx,我的映射中有这个

intersphinx_mapping = {
    "python": ("https://docs.python.org/3.6", None),
    "discord": ("https://discordpy.readthedocs.io/en/rewrite/", None),
}

我可以通过这样做来引用不和谐

:class:`discord.Guild

我也可以参考 Python 文档,就像那样

:py:class:`str`

但是,如果我尝试引用 TrueFalse,则无法正常工作。我正在这样做

:py:const:`True`

但文字不是超链接...

【问题讨论】:

    标签: python-3.x python-sphinx restructuredtext


    【解决方案1】:

    其中任何一个都将呈现链接。

    :py:obj:`True`
    
    :any:`True`
    

    【讨论】:

    • 还有:py:data:`True`
    • 您能解释一下为什么会这样吗?我很难理解 [documentation ](sphinx-doc.org/en/master/usage/restructuredtext/…) 的含义是“引用未指定类型的对象。有用,例如作为 default_role”
    • 我了解默认角色部分,但不明白为什么将其用作域可以链接到 True。我最好的猜测是 Python 中的一切都是一个对象,所以 :obj: 会带你去任何你需要去的地方吗?
    • 差不多。如果您不知道要记录的对象的类型(类、方法、数据、函数等),那么obj 是一个很好的包罗万象的类型。 any 在 reST 上下文而不是 Python 域中是相似的。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2012-10-30
    • 2021-05-04
    • 1970-01-01
    • 2019-09-24
    • 1970-01-01
    • 1970-01-01
    • 2020-06-01
    相关资源
    最近更新 更多