个人中心
文章发布
退出
作者热门文章
- html - 出于某种原因，IE8 对我的 Sass 文件中继承的 html5 CSS 不友好？
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景？
26
4
好的，我正在使用 Sphinx Autosummary 为某些类生成文档。有三种不同类型的类，我希望我的边栏有三个不同的部分，就像我在 toctree 指令中使用 :caption: 选项一样。
所以我添加了将我的自动摘要指令分成三个较小的指令，并且我在它们之间放置了一个隐藏的目录树，如下所示:
Section 1
.. toctree::
:hidden:
:caption: Section 1
.. autosummary
:toctree: stubs
myclass
anotherclass
Section 2
.. toctree::
:hidden:
:caption: Section 2
.. autosummary::
:toctree:
thirdclass
产生一个像这样的侧边栏:
myclass
anotherclass
thirdclass
这行不通。我的 index.html 的层次结构正是我想要的样子，但侧边栏缺少我的字幕，它们没有显示。当我在任何这些隐藏目录树下添加一个像 self 这样的页面时，标题会显示:
Section 1
.. toctree::
:hidden:
:caption: Section 1
self
.. autosummary
:toctree: stubs
myclass
anotherclass
Section 2
.. toctree::
:hidden:
:caption: Section 2
.. autosummary::
:toctree:
thirdclass
产生一个像这样的侧边栏:
SECTION 1 (caption)
Documentation Home
myclass
anotherclass
thirdclass
这就是我要找的东西，但我不想引用 self 或其他任何内容。我只想要字幕。我该怎么做？
最佳答案
toctree 的目的是组织嵌套页面，它应该至少有一个条目(文件名)。否则，使用它真的没有任何意义。
下面的标记使用 sphinx_rtd_theme 生成所需的侧边栏。我知道它不会给你你想要的索引页，但我想不出任何其他方法。将 autosummary 指令放在单独的文件中，并将每个文件添加为 toctree 条目。
.. toctree::
:caption: Section 1
autosummary1
.. toctree::
:caption: Section 2
autosummary2
关于python - 如何在不添加新文档的情况下在 Sphinx toctree 中添加标题？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/59327002/
26
4
0
我正在使用带有 numpydoc 扩展和自动摘要的 sphinx。经过一些实验，我在我的 conf.py 文件中添加了以下选项。 autosummary_generate = True numpydo
我不确定这是否可能。但我希望将多个 .rst 文件放在一个目录中，并在编译期间。我希望这些文件自动插入 toctree .我该怎么办？ 最佳答案 您可以使用 glob启用通配符的选项。像这样: ..
我可以通过两种方式创建目录: .. contents:: :local: depth: 1 或作为 .. toctree:: :maxdepth: 1 index 有什么区
Contents: .. toctree:: :maxdepth: 2 foo.rst bar.rst Indices and tables ================== *
我使用 Sphinx 和自动摘要生成 Python 软件的文档。它运行良好，但生成的 .rst 文件还列出了导入的函数和类，这不是我想要的行为。 例如带有文档字符串的包“packageex”: """
我正在尝试学习 sphinx 并且只停留在基本示例上。我在源目录中的 make html 中收到以下错误。 Running Sphinx v1.1.3 loading pickled environm
好的，我正在使用 Sphinx Autosummary 为某些类生成文档。有三种不同类型的类，我希望我的边栏有三个不同的部分，就像我在 toctree 指令中使用 :caption: 选项一样。 所以
toctree的常用用法在 Sphinx 中看起来像这样: .. toctree:: :maxdepth: 2 foo bar baz 如果，例如，foo.rst以标题“Bei
我是 Sphinx 的新手，并且一直在寻找这个问题的解决方案。 我的索引页是由 index.rst 制作的，其中包含一个目录树。该页面在正文和侧边栏中显示 TOC。我只想在侧边栏上显示目录，而不是在每
我正在使用 Sphinx构建我的文档。我正在使用其他工具进行 API 引用。我在一个目录中有我的文档，其中的目录名称 api 中有 API 引用。 我想要从文档到 API 引用的链接。我可以向我的目录
我正在本地主机上使用 readthedocs.org 实例从我的 github 存储库构建 HTML 文档，我希望能够执行以下操作。 目前，我有一个使用 toctree 的 glob 功能读取的文件列
这个问题已经有答案了: Conditional toctree in Sphinx (4 个回答) 已关闭 8 年前。 我想仅在设置特定标签时将我的文件之一包含在 Sphinx TOC 中，但是明显的
我试图在我的 toctree 中显式设置元素的标题。文档说应该是这样的: .. toctree:: All about strings 但它只打印 string.rst 文档中内容的标题，而
我正在尝试使用 sphinx 来记录多个“级别”的文档，例如: API 引用 手册 教程 等 这个想法是，目录显示在相对于您所在部分的侧边栏上。因此，当您在主索引上时，它只显示上述部分。当你进入例如。
我有一个以编程方式生成的 sphinx-doc 源，它使用 Read-The-Docs 主题。源树看起来像: source ├── conf.py ├── index.rst ├── models │
有谁知道按文件名降序排列 toctree 的任何选项？ 在升序的情况下，我们可以使用 :glob:像这样的选项: .. toctree: :glob: 2011* 这对于应该在 Sphin
我希望我在 sphinx 中的 toctree 包含主(index.rst)页面。文档建议包含“self”会执行此操作，但正如其他人在 stackoverflow 上指出的那样，这仅包含主页的标题，因
这是我对新的 Read The Docs 主题的理解 generates the sidebar from the toctree深度为2。我的文档比较深，深度2不够用。我怎样才能增加这个限制，或者最
我是狮身人面像的新手。我尝试了教程，但未能在内容中生成链接。我得到的错误 C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toct
是否可以从主 TOCTree 中隐藏 RST 文件中存在的一个(或所有)子节？ 让我再描述一下: index.rst :doc:`Label ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^
我是一名优秀的程序员,十分优秀！