问题标签 [toctree]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
1033 浏览

python - 如何使用 sphinx 生成 sitemap.xml 文件?

这里它说:“特殊条目名称 self 代表包含 toctree 指令的文档。如果您想从 toctree 生成“站点地图”,这很有用。” 我一直在研究这个问题——使用 self 在 sphinx 中创建带有 toctree 的站点地图似乎坏了?. 我似乎无法让它工作。

是否有任何地方可以查看由 sphinx 生成的站点地图的详细示例?

0 投票
2 回答
1569 浏览

html - 更改目录树中标题文本的颜色

有没有办法改变狮身人面像网页上字幕的颜色?我将:caption:指令与toctree一起使用,但标题的颜色与侧边栏几乎相同。作为参考,这里是带有难以看到标题的页面的链接,这是我的索引文件:

0 投票
2 回答
579 浏览

jinja2 - 模板化 Sphinx 的侧边栏目录树

我正在尝试制作一个新的 Sphinx 模板,该模板将为侧边栏创建一个自定义目录树。

使用 Jinja 模板语言,似乎只有一个功能可用:toctree()一次显示所有目录树,但我需要遍历各个目录树项目。

这看起来像这样:

可能吗?

0 投票
1 回答
1687 浏览

python-sphinx - 不同的目录树标题和文档标题,仅在文档源中指定

在目录树中插入文档时,显示的链接是文档的主标题。所以当我这样做时:

我得到:

材料

  • 漫反射材质
  • 光面材质
  • 镜面材质

“材料”一词在目录树中显然是多余的,但在文档标题中很重要,以便更好地理解。

RST 允许我这样写:

但我不喜欢这样,因为重命名文档需要更新索引目录树,而链接更新是我从 MediaWiki 转到 Sphinx 的原因。此外,这会禁止在目录树中使用 :glob: 和通配符

问题:有没有办法在叶子文档本身中指定一个目录树标题,例如在“diffuse.rst”中,作为元属性?

谢谢!

0 投票
2 回答
3623 浏览

python - 如何在 Sphinx Alabaster 主题下编辑侧边栏

我有以下index.rst文件。

现在侧边栏看起来像这样:

在此处输入图像描述

如该图像中所述。我想做几件事。

  1. 在侧边栏中删除标题,但在主页中保留它。
  2. 添加新的 URL 链接,但未在“索引和表格”之类的主页中显示它

我怎样才能做到这一点?

0 投票
1 回答
6224 浏览

matlab - 将子文件夹中的文件添加到 sphinx 文档 (sphinxcontrib-matlabdomain)

我有一个包含各种文件夹的目录,每个文件夹中都有 matlab 源文件。其中一些文件夹具有包含 matlab 源文件的子文件夹。

如何使用 Sphinx 创建 TOC 树以嵌套方式包含子文件夹?

例如,当Main-Directory包含conf.pyindex.rst、 以及moduleslist.rst以下文件夹结构时:

使用此index.rst文件:

这个moduleslist.rst文件:

但这不包括其中的子文件夹Folder2.1和文件。我尝试添加Folder2/indexindex.rst其中Folder2/index.rst包含 的自动模块Folder2.1,其中不包括ghi.m.

如何让 Sphinx 在其 TOC 树中显示嵌套的子文件夹?

0 投票
1 回答
3464 浏览

python-sphinx - 如何使 toctree 链接像引用小节一样引用单独的文件

结构

项目结构如下:

  • index.rst

    /li>
  • group1.rst

    /li>

渲染到(点击Group1->后Subgroup2):

点击小节

如您所见,它打开Group1页面并链接到Subgroup2部分。

我想在左侧有相同的内容(打开Group1Subgroup2选择),但在右侧我只想看到Subgroup2页面(没有Subgroup1内容的页面)。

即有文件group1/subgroup1.rst

渲染到:

想

如何实现?这是一个深度为 2 的简单示例,那么深度 3-4 呢?

0 投票
1 回答
46 浏览

python-sphinx - 从不同的目录树引用时生成具有不同面包屑的重复模板

我的文档结构如下所示:

生成的结构如下所示:

我的 foo 和 zoo 的目录树看起来像:

我想要编译 2 个不同的 shared.html 文件,一个带有面包屑看起来像breadcrumbs: home -> zoo -> shared,另一个是breadcrumbs: home -> foo -> shared. 狮身人面像有可能吗?

作为参考,这是我的面包屑生成模板代码:

0 投票
1 回答
6138 浏览

python - 自动为 Sphinx 中的 autodoc 类创建目录树

我希望增加我的一个库中的文档。我一直在使用 sphinx 来帮助构建文档,最近开始探索 autodoc 扩展。

似乎在大多数专业文档中,每个类文档页面都有一个所有文档方法的列表,顶部带有链接。或者,换句话说,顶部的目录树带有指向每个更深入的方法文档的超链接。

有没有办法为使用 autodoc 记录的每个类自动创建这个目录树?

0 投票
1 回答
121 浏览

python-sphinx - 将次要页面放在目录中的正确位置

在我的 sphinx 文档中,我有一些小页面(当然)需要成为目录树的一部分,但我无法将它们列在正确的位置。

如果我的“第 3 节”页面如下所示:

然后3.3之前3.4都列出来了。 3

我尝试了其他排列,但似乎没有一个有效。

  1. 如果我将目录树放在3标题之后,则在3.3之间3.4列出。 33.1
  2. 如果我将目录树放在页面的末尾,一切都按正确的顺序排列,但3.3成为3.4第三级部分,即 section 的子级3.2

我在这里举了一个具体的例子: