我有一个名为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
要仅在链接中查看名称本身,可以在链接中使用
~
:这将呈现为
IOSCfgLine
,而不是models_cisco.IOSCfgLine
但是,如果我在代码库中正确地看到它,那么所有类都可以在顶级包名称空间中使用。因此,您也可以这样记录它们(因此没有
.. module:: models_cisco
,但是.. module:: ciscoconfparse
)相关问题 更多 >
编程相关推荐