You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何覆盖reST中autoclass指令生成的类标题文本?

如何替换reST autoclass生成的类标题

当然可行!你有两种简单的方法来把dataframe.DataFrame的显示标题换成自定义文本(比如EzPyZ.DataFrame),具体如下:

方法一:使用:annotation:参数快速替换

这是最直接的方式,只需要在autoclass指令里添加:annotation:选项,指定你想要显示的类名即可:

.. autoclass:: dataframe.DataFrame
    :annotation: EzPyZ.DataFrame

生成的文档里,类的标题就会直接显示为EzPyZ.DataFrame,同时保留原类的所有文档内容和结构。

方法二:自定义标题层级+隐藏原索引

如果你需要更灵活地控制标题的层级(比如想要用二级标题而非默认的一级),可以先手动编写自定义标题,再用:noindex:参数避免原类被重复索引:

## EzPyZ.DataFrame

.. autoclass:: dataframe.DataFrame
    :noindex:

这种方式下,你可以完全自定义标题的格式和层级,同时原类的文档内容会完整展示在自定义标题下方,而且不会在索引里出现重复条目。

两种方法都能满足你的需求,根据自己的文档结构选择就行~

内容的提问来源于stack exchange,提问作者Ethan Guthrie

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.05.11 07:28:45