多个文件中类的Sphinx文档

Question

背景

我有一个名为ciscoconfparse的项目，它是用sphinx编写的；该项目的文档是here。在

source code directory有多个文件：

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

这是我如何记录IOSCfgLine。。。在

.. module:: models_cisco

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

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

现有的Sphinx文档有一些非常难看的类超链接，包括文件名和类名；一个例子是models_cisco.IOSCfgLine。在

示例文档截图：

问题

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

Answer 1

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

:class:`~models_cisco.IOSCfgLine`

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

---

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