Sphinx生成Python文档:如何移除或取消加粗Return type行?
解决Sphinx中多余加粗Return type行的问题
你看到的加粗Return type:行并非Napoleon扩展生成,而是sphinx_autodoc_typehints扩展自动添加的——它会提取代码中的类型提示,单独生成返回类型行,和Napoleon的配置互不冲突。
方案1:彻底移除该行
在项目的conf.py中添加sphinx_autodoc_typehints的专属配置:
typehints_document_rtype = False
该配置会禁用该扩展自动生成返回类型行的功能,配合已设置的napoleon_use_rtype = False,就能彻底消除多余的返回类型标注。
方案2:取消加粗格式
若不想移除该行,仅需取消其加粗效果,可通过自定义CSS实现:
- 在Sphinx项目的
_static目录下创建custom.css文件 - 在
conf.py中配置引入该CSS文件:html_css_files = [ 'custom.css', ] - 在
custom.css中添加以下样式代码:
这样就能让.rtype { font-weight: normal; }Return type:行的字体权重恢复为普通,不再加粗。
内容的提问来源于stack exchange,提问作者winter
相关产品推荐
相关产品推荐

