从类的交叉引用中省略模块名称

Question

背景

我有一个名为顺糖解析的项目，它是用狮身人面像记录的；该项目的文档是这里。

源代码目录有多个文件：

• ciscoconfparse.py包含类CiscoConfParse和IOSConfigList
• models_cisco.py包含一个名为IOSCfgLine的类

这是我如何记录IOSCfgLine的一个例子.

.. module:: models_cisco

IOSCfgLine Object
-----------------

.. autoclass:: IOSCfgLine
      :members:
      :inherited-members:

现有的Sphinx文档具有可怕的类超链接，包括文件名和类名；一个例子是models_cisco.IOSCfgLine。

示例文档屏幕截图：

​

问题

如何使用autoclass来记录各种Python中的类，并且只看到呈现的文档中的类名，而不是类中包含的文件名？换句话说，我只想看到指向IOSCfgLine的超链接，而不是models_cisco.IOSCfgLine。

Answer 1

若要仅在链接中查看名称本身，可以在链接中使用~：

:class:`~models_cisco.IOSCfgLine`

这将呈现为IOSCfgLine而不是models_cisco.IOSCfgLine。

但是，如果我在您的代码库中正确地看到了它，那么所有类都可以在toplevel包名称空间中使用。因此，您也可以这样记录它们(所以没有.. module:: models_cisco，但是.. module:: ciscoconfparse)。