Как найти отображение межфинкса для wx.CheckBoxState

Question

Для документации по проекту я использую отображение intersphinx в документации по 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

Бегущий Сфинкс производит

Как видите, ссылки на "int", "str", "wx.Validator" работают нормально, но обе попытки найти ссылку на wx.CheckBoxState не увенчались успехом.

Есть еще жестко закодированный способ (прямая ссылка на страницу), но я бы предпочел умный (:py:class:...).

Кто-нибудь может помочь?

заранее спасибо
Humbalan

Кстати: я работаю с 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, изменить документы и, возможно, их исходный код, пока не получите его, чтобы сгенерировать нужную ссылку, а затем отправить им запрос на извлечение.