python - Sphinx 中 toctree 的显式标题-6ren

python - Sphinx 中 toctree 的显式标题

转载作者：行者123 更新时间：2023-12-01 05:53:34

25

4

我试图在我的 toctree 中显式设置元素的标题。文档说应该是这样的:

.. toctree::

    All about strings <string>

但它只打印 string.rst 文档中内容的标题，而不是“All about strings”。

有人有想法吗？

最佳答案

我可以通过 Sphinx 1.1.2 确认这一点。这似乎是一个错误，可能是 issue #86 的回归。这个问题显然已在 0.5.2 中修复。，但似乎又找到了回来的路。

关于python - Sphinx 中 toctree 的显式标题，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/13422729/

25

4

0

文章推荐： r - ggplot2 中每个组的不同 scale_fill_gradient

文章推荐： php - ajax获取下拉依赖值

文章推荐： jquery - 使用 jQuery 从中心放大图像

python - 带有 toctree 的自动摘要不为方法创建文档
我正在使用带有 numpydoc 扩展和自动摘要的 sphinx。经过一些实验，我在我的 conf.py 文件中添加了以下选项。 autosummary_generate = True numpydo
directory - 自动 toctree 更新
我不确定这是否可能。但我希望将多个 .rst 文件放在一个目录中，并在编译期间。我希望这些文件自动插入 toctree .我该怎么办？最佳答案您可以使用 glob启用通配符的选项。像这样: ..
python - Sphinx - toctree 和内容之间有什么不同？
我可以通过两种方式创建目录: .. contents:: :local: depth: 1 或作为 .. toctree:: :maxdepth: 1 index 有什么区
python - 关于 toctree 引用的警告
Contents: .. toctree:: :maxdepth: 2 foo.rst bar.rst Indices and tables ================== *
python - 使用 toctree 的自动摘要还列出了导入的成员
我使用 Sphinx 和自动摘要生成 Python 软件的文档。它运行良好，但生成的 .rst 文件还列出了导入的函数和类，这不是我想要的行为。例如带有文档字符串的包“packageex”: """
python - 无法让狮身人面像在 toctree 下链接到另一个文档
我正在尝试学习 sphinx 并且只停留在基本示例上。我在源目录中的 make html 中收到以下错误。 Running Sphinx v1.1.3 loading pickled environm
python - 如何在不添加新文档的情况下在 Sphinx toctree 中添加标题？
好的，我正在使用 Sphinx Autosummary 为某些类生成文档。有三种不同类型的类，我希望我的边栏有三个不同的部分，就像我在 toctree 指令中使用 :caption: 选项一样。所以
python-sphinx - 带注释的 Sphinx toctree
toctree的常用用法在 Sphinx 中看起来像这样: .. toctree:: :maxdepth: 2 foo bar baz 如果，例如，foo.rst以标题“Bei
python-sphinx - 仅在侧边栏中的 Sphinx toctree
我是 Sphinx 的新手，并且一直在寻找这个问题的解决方案。我的索引页是由 index.rst 制作的，其中包含一个目录树。该页面在正文和侧边栏中显示 TOC。我只想在侧边栏上显示目录，而不是在每
python-sphinx - Sphinx toctree 指令中的外部相对链接
我正在使用 Sphinx构建我的文档。我正在使用其他工具进行 API 引用。我在一个目录中有我的文档，其中的目录名称 api 中有 API 引用。我想要从文档到 API 引用的链接。我可以向我的目录
python-sphinx - 从 toctree 隐藏特定文件？
我正在本地主机上使用 readthedocs.org 实例从我的 github 存储库构建 HTML 文档，我希望能够执行以下操作。目前，我有一个使用 toctree 的 glob 功能读取的文件列
python - 如何有条件地将文件包含在 Sphinx 'toctree' 中？
这个问题已经有答案了: Conditional toctree in Sphinx (4 个回答) 已关闭 8 年前。我想仅在设置特定标签时将我的文件之一包含在 Sphinx TOC 中，但是明显的
python - Sphinx 中 toctree 的显式标题
我试图在我的 toctree 中显式设置元素的标题。文档说应该是这样的: .. toctree:: All about strings 但它只打印 string.rst 文档中内容的标题，而
python - Python-Sphinx 中的多级 Toctree
我正在尝试使用 sphinx 来记录多个“级别”的文档，例如: API 引用手册教程等这个想法是，目录显示在相对于您所在部分的侧边栏上。因此，当您在主索引上时，它只显示上述部分。当你进入例如。
makefile - 为什么 toctree 没有用 RTD 主题更新？
我有一个以编程方式生成的 sphinx-doc 源，它使用 Read-The-Docs 主题。源树看起来像: source ├── conf.py ├── index.rst ├── models │
sorting - 如何反转 "glob"标志选项提供的 toctree 的顺序？
有谁知道按文件名降序排列 toctree 的任何选项？在升序的情况下，我们可以使用 :glob:像这样的选项: .. toctree: :glob: 2011* 这对于应该在 Sphin
python - 在 toctree 中使用 self 不包括子部分
我希望我在 sphinx 中的 toctree 包含主(index.rst)页面。文档建议包含“self”会执行此操作，但正如其他人在 stackoverflow 上指出的那样，这仅包含主页的标题，因
python - 在 Read The Docs 侧边栏中显示整个 toctree
这是我对新的 Read The Docs 主题的理解 generates the sidebar from the toctree深度为2。我的文档比较深，深度2不够用。我怎样才能增加这个限制，或者最
python - 无法在 Sphinx 中获取 TOCTREE 以显示链接
我是狮身人面像的新手。我尝试了教程，但未能在内容中生成链接。我得到的错误 C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toct
python-sphinx - 从主 TOCTree 中隐藏 Sphinx 子部分
是否可以从主 TOCTree 中隐藏 RST 文件中存在的一个(或所有)子节？让我再描述一下: index.rst :doc:`Label ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^

首页

博学

6Ren·AI

商城

python - Sphinx 中 toctree 的显式标题