在阅读文档侧栏中显示整个目录树

Show entire toctree in Read The Docs sidebar(在阅读文档侧栏中显示整个目录树)
本文介绍了在阅读文档侧栏中显示整个目录树的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我的理解是新的阅读文档主题generates the sidebar from the toctree,深度为2。我的文档相对深入,深度2是不够的。如何增加或最好完全删除此限制?

如果这不可能,我如何使用本地目录而不是全局目录树?

推荐答案

注意:上一个答案已过时。正如@Ariel在一条评论中指出的那样,现在可以通过在html_theme_options中设置navigation_depth来配置maxdepth。根据README,在您的项目的conf.py:

中更改此设置
html_theme_options = {
    'navigation_depth': 4,
}

查看source for the theme on Github,似乎TOC深度在line 93 in sphinx_rtd_theme/layout.html上是硬编码的。因此,您无法对主题进行配置来覆盖它。

由于该行是硬编码的,因此您将始终获得由toctree返回的全局toctree,而不是由以下行"支持"的本地toctree。

当然,您可以派生主题并更改该行以供本地使用(您还可以在RTD上使用定制主题,因此也可以在那里工作)。我试着用演示主题来这样做。它看起来像maxdepth=3,所以可能需要一些额外的css。documentation for the toctree template function指定对于无限深度,只需传递maxdepth=-1即可。请注意,这不会将折叠/展开添加到目录的子级别。

可能是拉入请求的好目标?

这篇关于在阅读文档侧栏中显示整个目录树的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)