如何找到 wx.CheckBoxState 的 intersphinx 映射

Question

对于我的项目文档，我使用 intersphinx mapping to the wxpython documentation. That works fine so far but I don't succeed to get a link to 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

运行狮身人面像产生

如您所见，links 到 "int"、"str"、"wx.Validator" 工作正常，但两者都试图找到 link 到 [=36] =] 没有成功。

仍然有硬编码方式（直接 link 到页面），但我更喜欢智能方式 (: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 签出，修改文档和可能的源代码，直到您让它生成您想要的 link，然后向他们提交拉取请求。

如何找到 wx.CheckBoxState 的 intersphinx 映射

How to find an intersphinx mapping for wx.CheckBoxState

python

wxpython

restructuredtext

python-3.x

python-sphinx