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

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。

<小时/>

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