如何在最新版Sphinx中恢复~3.5.4版本的自动生成签名样式
Sphinx 4.0+ 恢复3.5.x版本签名样式方法
Sphinx 从3.5.4版本迭代到4.0.1版本后,自动生成的签名样式发生了变更:
- 旧版样式:

- 新版样式:

要在新版本中恢复旧版单行紧凑签名样式,可按以下步骤操作:
方法1:修改配置文件(优先推荐)
打开Sphinx项目根目录下的conf.py,加入以下配置项:
# 关闭Python域的多行签名特性 python_signature_multi_line = False # 全局设置签名最大行宽为极大值,避免签名自动折行 maximum_signature_line_length = 9999
修改完成后重新执行sphinx-build构建文档即可。
方法2:自定义CSS兜底适配
如果方法1未完全还原样式,可通过自定义CSS覆盖默认样式:
- 在Sphinx项目的静态资源目录(通常为
_static)下新建custom.css,写入以下内容:
/* 取消参数单独换行和缩进 */ .sig-param { display: inline-block; padding-left: 0; } /* 避免括号单独换行 */ .sig-paren { white-space: nowrap; }
- 在
conf.py中引入自定义CSS:
html_css_files = ["custom.css"]
重新构建文档即可生效。
内容的提问来源于stack exchange,提问作者hchw
相关产品推荐
相关产品推荐

