如何在Sphinx-doc的autodoc模块中隐藏类属性前的property前缀

解决方案 #

该问题是Sphinx 4.0及以上版本的默认新增行为，默认会为Python类属性添加property前缀标识，你可以通过以下两种方案快速关闭该展示效果：

方案1：修改Sphinx配置（推荐）

直接在项目的Sphinx配置文件conf.py中添加如下配置项即可：

# 关闭Python属性的property前缀展示
python_show_property_type = False

修改完成后重新执行sphinx-build构建文档，即可恢复旧版本的展示效果，类属性前的property前缀会直接移除，方法的括号标识也会保留，接口成员可以正常对齐。

方案2：自定义CSS隐藏（兼容所有版本）

如果配置项不生效（比如使用了第三方Sphinx主题不支持该配置），可以通过自定义样式强制隐藏前缀：

• 在Sphinx项目的_static目录下新建custom.css文件，写入以下内容：

/* 隐藏property前缀 */
em.property {
    display: none !important;
}

• 在conf.py中引入该自定义CSS文件：

html_css_files = [
    'custom.css',
]

重新构建文档即可生效。

内容的提问来源于stack exchange，提问作者scanny