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

Question

背景

我有一个名为ciscoconfparse的项目，用Sphinx记录；该项目的文档在这里。

源代码目录有多个文件：

• 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

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

:class:`~models_cisco.IOSCfgLine`

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

---

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