时间戳

首页 > 解决方案 > 有没有办法覆盖 autoclass 指令 reST 显示的文本？

python-sphinx - 有没有办法覆盖 autoclass 指令 reST 显示的文本？

问题描述

我使用 reST 中的 autoclass 指令创建了文档，它为类生成了一个标题，如下所示：

阅读文档示例

但是，我想要的是它不说dataframe.DataFrame而是EzPyZ.DataFrame（或者实际上是对该默认文本的任何手动覆盖）。这是我使用的代码：

.. autoclass:: dataframe.DataFrame

标签： python-sphinxrestructuredtextread-the-docsautodoc

解决方案

答案如我所料。我是个白痴。正如@mzjn 指出的那样，我所要做的只是简单地说：

.. autoclass: EzPyZ.DataFrame

自动文档将填写您指定的路径，只要它是类的有效路径。在我的情况下（参见下面的目录结构），Column可以使用EzPyZ.column.Column, column.Column（因为 autodoc 隐式导入目标包以获取文档）或（如我所愿）来访问该类EzPyZ.Column。

  EzPyZ
    └── EzPyZ
          ├── __init__.py
          ├── column.py      # Contains Column class.
          ├── dataframe.py   # Contains DataFrame class.
          └── tools
                ├── __init__.py
                └── read_files.py    # Contains some extra functions.

推荐阅读