для моей проектной документации я использую межфиксное сопоставление в документации 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:...).
Может ли кто-нибудь помочь?
заранее спасибо
Humbalan
Кстати: я работаю с sphinx 1.7.5, python 3.7 и wxpython 4.0.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, изменить документы и, возможно, их исходный код, пока не получите его для создания нужной ссылки, а затем отправьте запрос на перенос.
:any:`wx.CheckBoxState`
будет работать, но это не так. sphinx-doc.org/en/master/usage/restructuredtext/...