如何为wx.CheckBoxState

Question

对于我的项目文档，我在wxpython文档中使用了intersphinx mapping。到目前为止，效果还不错，但是我没有成功获得指向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：...）。

有人可以帮忙吗？

预先感谢
洪堡语

顺便说一句：我使用的是狮身人面像1.7.5，python 3.7和wxpython 4.0.1

Answer 1

取决于您的狮身人面像之间的映射配置，您可能需要对其进行调整。假设它看起来像这样：

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的签出，修改文档以及可能的源代码，直到获得生成所需链接的文档，然后向他们提交拉取请求。