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

Question

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

​

​

但是，我希望它不显示dataframe.DataFrame，而显示EzPyZ.DataFrame (或者实际上手动覆盖默认文本)。这是我使用的代码：

.. autoclass:: dataframe.DataFrame

Answer 1

答案正如我所料。我是个笨蛋。正如@mzjn所指出的，我所要做的就是简单地说：

.. autoclass: EzPyZ.DataFrame

autodocs将填充您指定的路径，只要它是指向类的有效路径即可。在我的例子中(参见下面的目录结构)，可以使用EzPyZ.column.Column、column.Column (因为autodoc隐式地导入了用于文档的targe包)或(正如我所希望的) EzPyZ.Column来访问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.