python - Sphinx文档，用于多个文件中的类

背景

我有一个名为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的超链接。

最佳答案

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

:class:`~models_cisco.IOSCfgLine`

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



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