在Sphinx中使用Python域中的交叉引用角色

Question

我无法理解在Python域中使用交叉引用角色，特别是：py：const：有人可以提供更清晰的解释及其使用示例吗？

例如，我有一个文件module.rst，其中包含以下指令：

.. default-role:: any
.. automodule:: CommonSymbols
       :members:

:py:const: Success
:py:mod: CommonSymbols

从我期望的文档：py：const：SUCCESS，其中SUCCESS是模块CommonSymbols中定义的变量，用于生成CommonSymbols中SUCCESS定义的链接。类似地，在以下情况下我会期望链接到模块CommonSymbols：py：mod：遇到CommonSymbols。

相反，我在显示的HTML中获得了以下两个角色的输出：

:py:const: Success :py:mod: CommonSymbols

这完全是无用的，这就是我问这些角色如何实际起作用的原因。

Answer 1

来自:py:const:的交叉引用Python对象下的文档：

  

此标记中包含的名称可以包含模块名称和/或类名称。例如，

:py:func:`filter`

  

可以引用当前模块中名为filter的函数，或者该名称的内置函数。

尝试：

:py:const:`CONSTANT`