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

Sphinx使用autodoc系列指令时如何仅引入目标对象的文档内容

仅提取类文档字符串的Sphinx实现方法

要在Bar类的文档字符串中仅嵌入Foo类的文档内容,而不显示类名和签名,有两种实用方案:

方案一:使用autoclass的:content-only:选项(推荐)

如果你的Sphinx版本是4.0及以上,直接在Bar的文档字符串中使用以下指令:

.. autoclass:: Foo
   :content-only:

该选项会自动只渲染Foo类的文档字符串内容,完全跳过类名、签名等额外信息。

方案二:低版本Sphinx的替代方案

若使用的Sphinx版本低于4.0,可以通过autoattribute指令提取类的__doc__属性,再配合:noindex:避免生成索引:

.. autoattribute:: Foo.__doc__
   :noindex:

这种方法会显示__doc__作为标题,如果你想完全隐藏标题,可以通过自定义CSS样式将其移除,或者在项目的conf.py中配置autodoc_docstring_signature = False来优化显示效果。

内容的提问来源于stack exchange,提问作者Jacek Karolczak

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.08.11 15:05:29