python - 如何找到 wx.CheckBoxState 的 intersphinx 映射

Question

对于我的项目文档，我使用 intersphinx mapping到 wxpython 文档。到目前为止效果很好，但我没有成功获得 wx.CheckBoxState 的链接。我试图在这里和其他论坛中查找相关信息，但没有找到任何信息。

这是我的代码:

def my_meth( self, value, aStr ):
    """
    :param int value: This is my value
    :param str aStr: This is another value

    Description using

    - :py:class:`wx.CheckBoxState`
    - :py:class:`wx.CheckBoxState.enumeration`
    - :py:class:`wx.Validator`
    """
    self.my_var = value
    self.my_str = aStr

运行 Sphinx 会产生

正如您所看到的，指向“int”、“str”、“wx.Validator”的链接工作正常，但是两次尝试查找指向 wx.CheckBoxState 的链接都没有成功。

仍然有硬编码方式(直接链接到页面)，但我更喜欢智能方式(:py:class:...)。

有人可以帮忙吗？

提前致谢
洪巴兰

顺便说一句:我使用 sphinx 1.7.5、python 3.7 和 wxpython 4.0.1

Answer 1

根据您的 intersphinx 映射配置，您可能需要对其进行调整。假设它看起来像这样:

intersphinx_mapping = {
    'wx': ('https://docs.wxpython.org/', None),
}

然后你会这样做:

def my_meth( self, value, aStr ):
    """
    :param int value: This is my value
    :param str aStr: This is another value

    Description using

    - :ref:`wx.CheckBoxState`
    - :py:class:`wx.Validator`
    """
    self.my_var = value
    self.my_str = aStr

我假设:py:obj:可以作为 wx.CheckBoxState 和 wx.CheckBoxState.enumeration 的未指定类型的对象，但事实并非如此。我又转而使用 :ref:，它适用于 wx.CheckBoxState，但不适用于 wx.CheckBoxState.enumeration，所以我删除了后者。对我来说，它们似乎是文档中的相同目标。

风格可能会有所不同，但我认为这是您对开箱即用的 wxPython 文档所能期望的最好结果。

您可以尝试修改 wxPython 的 checkout ，修改文档以及可能的源代码，直到它生成您想要的链接，然后向他们提交拉取请求。