Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/358.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/6/cplusplus/132.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python 从类的交叉引用中省略模块名称 背景_Python_Python Sphinx_Cross Reference - Fatal编程技术网

Python 从类的交叉引用中省略模块名称 背景

Python 从类的交叉引用中省略模块名称 背景,python,python-sphinx,cross-reference,Python,Python Sphinx,Cross Reference,我有一个名为的项目,该项目由;该项目的文档是 具有多个文件: ciscoconfparse.py包含类ciscoconfparse和IOSConfigList models\u cisco.py包含一个名为IOSCfgLine 这是我如何记录IOSCfgLine的一个例子 .. module:: models_cisco IOSCfgLine Object ----------------- .. autoclass:: IOSCfgLine :members:

我有一个名为的项目,该项目由;该项目的文档是

具有多个文件:

  • ciscoconfparse.py
    包含类
    ciscoconfparse
    IOSConfigList
  • models\u cisco.py
    包含一个名为
    IOSCfgLine
这是我如何记录
IOSCfgLine
的一个例子

.. module:: models_cisco

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

.. autoclass:: IOSCfgLine
      :members:
      :inherited-members:
现有的Sphinx文档具有可怕的类超链接,包括文件名和类名;一个例子是
models\u cisco.IOSCfgLine

示例文档屏幕截图:

问题:
如何使用
autoclass
记录各种Python文件中的类,并仅在呈现的文档中看到类名,而不是类中包含的文件名?换句话说,我只想看到指向
IOSCfgLine
的超链接,而不是
models\u cisco。IOSCfgLine

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

:class:`~models_cisco.IOSCfgLine`
这将呈现为
IOSCfgLine
,而不是
models\u cisco.IOSCfgLine


但是,如果我在代码库中正确地看到它,那么所有类都可以在顶级包名称空间中使用。因此,您也可以这样记录它们(因此没有
.module::models\u cisco
,但是
.module::ciscoconfparse