Sphinx RTD主题面包屑排除类名,仅保留包名配置方法
如何让Sphinx左侧导航仅保留包层级
要实现类似目标文档的包层级导航,去掉左侧栏中的类名和方法条目,可通过以下两步操作:
1. 修改ReadTheDocs主题配置
在Sphinx的conf.py配置文件中添加主题选项,禁用自动生成的对象条目:
html_theme_options = { 'toc_object_entries': False }
这个配置会让侧边栏只显示你手动通过toctree定义的包层级导航,不会把autodoc生成的类、方法等内容加入到导航目录中。
2. 调整toctree的深度设置
检查各rst文件中的toctree指令,确保层级深度只覆盖包层级:
比如在a_faker.faker.providers.rst中,将:maxdepth:设为1(可根据实际包结构调整):
Custom providers ====================================================== .. toctree:: :maxdepth: 1 a_faker.faker.providers.person a_faker.faker.providers.transaction
这样侧边栏只会显示"Custom providers"下的各个provider包,不会深入到包内的类和方法。
验证效果
修改配置后重新构建文档(执行sphinx-build命令),左侧导航就会只保留你需要的包层级结构,类和方法的内容仍会正常显示在页面中,但不会出现在侧边导航里。
内容的提问来源于stack exchange,提问作者lapots
相关产品推荐
相关产品推荐

