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

Question

背景

我有一个名为ciscoconfparse 的项目，它记录在Sphinx 中；该项目的文档是here。

source code directory 有多个文件：

• 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。

---

但是，如果我在您的代码库中正确地看到它，那么所有类都在顶级包名称空间中可用。所以你也可以这样记录它们（所以没有.. module:: models_cisco，但是.. module:: ciscoconfparse）。