Sphinx使用:show-inheritance:时如何隐藏基类包/模块名(add_module_names配置无效)
Sphinx精简autoclass继承块基类名称的可行方案
add_module_names = False仅控制类、函数等对象自身标题的模块名前缀展示,不会作用于:show-inheritance:生成的基类列表渲染流程,因此需针对性调整继承项的名称处理逻辑,可落地方案如下:
- 方案1:通过autodoc事件钩子定制基类名称裁剪规则
该方案从渲染源头修改基类展示名称,稳定性最高,适配所有Sphinx 1.6+版本,具体操作:- 在
conf.py中注册autodoc-process-bases事件处理函数,在渲染前对收集到的基类全路径名做裁剪
参考实现代码:
适配调整:如果项目存在跨包同名基类的场景,可修改拆分逻辑保留部分上层模块路径(比如保留最后2段路径),避免展示产生歧义。def trim_base_class_name(app, what, name, obj, options, bases): processed_bases = [] for base_fullname in bases: # 拆分点分全路径,提取最终类名作为展示名 short_name = base_fullname.split('.')[-1] processed_bases.append(short_name) # 返回处理后的列表,替换原始的全路径基类数据 return processed_bases def setup(app): # 将自定义处理逻辑挂载到Sphinx的文档生成流程 app.connect('autodoc-process-bases', trim_base_class_name) - 在
- 方案2:自定义渲染模板调整继承块输出
针对仅需视觉层面精简、无需修改核心逻辑的场景,可覆盖Sphinx内置的类渲染模板:- 在docs项目下创建
templates目录,按照内置模板路径规则放置自定义的class.rst模板文件 - 在模板中定位继承列表的渲染段,通过正则匹配对全路径字符串做裁剪后再输出
该方案和特定Sphinx版本的模板结构耦合度较高,版本升级时需同步适配模板规则。
- 在docs项目下创建
内容的提问来源于stack exchange,提问作者The_Fallen
相关产品推荐
相关产品推荐

