多个文件中的类的Sphinx文档

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