将常量的用法链接到Sphinx中的定义

时间:2018-07-16 11:28:46

标签: python python-sphinx autodoc

我有一个Python类,其成员VALID_KEYS定义为

VALID_KEYS = [
    Keys.UP,
    Keys.DOWN,
    Keys.RIGHT,
    Keys.LEFT,
    Keys.SPACE,
    'r',
    'b',
    'y'
]

其中“键”是selenium.webdriver.common.keys.Keys。我建立了一个sphinx链接,因此我可以在我的文档字符串中引用该类,但是我希望此属性的文档显示符号而不是这些键的值,并链接到原始文档。

当前,使用autodoc时我得到

  

VALID_KEYS = ['\ ue013','\ ue015','\ ue014','\ ue012','\ ue00d','r',   'b','y']¶

这比我想要的要难理解:

  

VALID_KEYS = [selenium.webdriver.common.keys.Keys.UP,selenium.webdriver.common.keys.Keys.DOWN,selenium.webdriver.common.keys.Keys.RIGHT,selenium.webdriver.common.keys。 Keys.LEFT,selenium.webdriver.common.keys.Keys.SPACE,'r',   'b','y']¶

我宁愿不必直接在文档中复制这些值,但愿意澄清一下。

0 个答案:

没有答案