问题标签 [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 投票
1 回答
6359 浏览

python - 无法让 sphinx 在 toctree 下链接到另一个文档

我正在尝试学习狮身人面像,并且只停留在基本示例上。我make html在源目录中收到以下错误。

我也尝试过引用introintro.rst不是似乎都不起作用。index.rst并且intro.rst在同一个目录中。我使用sphinx-quickstart所有默认选项制作了项目。

0 投票
1 回答
6934 浏览

python-sphinx - Disabling individual Sphinx warning messages

I have many .rst files in my Sphinx tree which are intentionally excluded from any index tree. I get warnings like

How can I suppress specific warnings in Sphinx?

0 投票
1 回答
3896 浏览

python-sphinx - 在 Sphinx 中包含另一个页面的 ToC

我在 plugins/index.html 有以下页面:

plugin/basics/index.html 和 plugins/advanced/index.html 包含它们自己的目录树,它们链接到 plugins/index.html 中列出的相同子页面。所以我想知道的是,有没有办法只包括那些子目录树,而不是像我一样手动列出子页面?

我意识到我可以从目录树中删除 :hidden: 标志,但关键是我想将基本/高级主题保留在单独的列表中,并带有它们自己的标题、介绍段落等。

0 投票
1 回答
595 浏览

python-sphinx - 在表格内创建目录

我希望能够在表格中生成目录。例如,它应该有边框并且看起来像这样:

我想从以下内容自动生成表格:

输出为 html 和 pdf。

这可以做到吗?还是我必须使用 docutils 解析器或类似的?

0 投票
2 回答
372 浏览

python - Sphinx中toctree的显式标题

我试图在我的toctree. 文档说应该是这样的:

但它只打印 string.rst 文档中内容的标题,而不是“关于字符串的全部内容”。

有人有想法吗?

0 投票
1 回答
10401 浏览

python - 无法在 Sphinx 中获取 TOCTREE 以显示链接

我是狮身人面像的新手。我尝试了教程,但未能在内容中生成链接。我得到的错误

我已经创建zuhdi.rstintro.rst在同一目录中index.rst。我怎样才能给文件加上标题?

供您参考,我的 index.rst 包含以下几行:

我必须存在这些文件才能将链接放入目录树中吗?intro.rstandzuhdi.rst只是一个空文件。

0 投票
3 回答
5445 浏览

python - 如何在 Sphinx 中扩展侧边栏目录树上的所有小节?

我想知道是否有办法扩展文件中包含的标题下的所有小节index.rst

例如,它是这样的:

这就是我希望的样子:

如果我点击第 1 节,它会显示下面的内容,但如果我点击第 2 节,第 1 节的内容会被隐藏,只显示 2 节。每次我在索引页面上时,我都希望扩展所有 2 个部分。我试过添加toctreeand maxdepth,没有任何效果。

0 投票
4 回答
2901 浏览

conditional-statements - Sphinx 中的条件目录树

我想做一个文档的多个版本,它们在包含的部分中有所不同。为了实现这一点,我通常会使用only指令或ifconfig扩展。但是,我不能将其中任何一个与toctree指令结合使用。

我基本上想要的是这样的:

有没有办法做到这一点?

0 投票
5 回答
11958 浏览

python-sphinx - 从主 TOCTree 隐藏 Sphinx 小节

是否可以从主 TOCTree 隐藏 RST 文件中存在的一个(或所有)小节?

让我再描述一下:

索引.rst

孩子/file.rst

这些文件在构建后将生成主 TOCTree:

  • 标签
  • 标签
  • 儿童标签
    • 孙子的标签 1
    • 孙子的标签 2
    • 第 1 款
    • 第 2 小节
    • 第 3 小节

而且我想隐藏子部分,只保留 TOCTrees,尽可能多和尽可能深。例如:

  • 标签
  • 标签
  • 儿童标签
    • 孙子的标签 1
    • 孙子的标签 2

但是,如果单击与儿童标签关联的超链接,则子部分将照常列出;

0 投票
1 回答
892 浏览

python-sphinx - 如何在 Sphinx globaltoc 侧边栏中包含所有文档?

我希望将整个 TOC 中的每个文档都包含在 globaltoc 侧边栏中。我如何实现这一目标?

在主题文件中,有对 的调用{{ toctree() }},但我不知道toctree()指的是什么。