带注释的狮身人面像树

2024-03-05

通常使用toctree在狮身人面像中看起来像这样:

.. toctree::
   :maxdepth: 2

   foo
   bar
   baz

举例来说,如果foo.rst以标题“Being Foo”开头,bar.rst从“做酒吧”开始,并且baz.rst以“Thinking Baz”开头,然后你会得到一个很好的目录,如下所示:

  • 成为 Foo http://example.com/foo.html
  • 做酒吧 http://example.com/bar.html
  • 思考巴兹 http://example.com/baz.html

每个页面都有指向相应页面的链接。

我的问题:有没有办法注释 toctree?例如,如果我想用“W. Robert Foo 在 1857 年创建了第一个元句法变量,从那时起我们就一直使用它。”之类的内容来注释“Being Foo”标题,那么我可以将该文本放在某处(希望如此)在顶端foo.rst,但如果没有,则在 toctree 指令中)并且 toctree 输出将如下所示:

  • 成为 Foo http://example.com/foo.html— W. Robert Foo 在 1857 年创建了第一个元句法变量,从那时起我们就一直在使用它。
  • 做酒吧 http://example.com/bar.html
  • 思考巴兹 http://example.com/baz.html

您可以使用以下语法覆盖页面标题:

.. toctree::
   :maxdepth: 2

   Being Foo - W. Robert Foo created the first metasyntactic variable in 1857 <foo>
   bar
   baz

http://www.sphinx-doc.org/en/stable/markup/toctree.html?highlight=entries http://www.sphinx-doc.org/en/stable/markup/toctree.html?highlight=entries

但是,您会丢失自动标题,这可能是您问题的主要部分?

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

带注释的狮身人面像树 的相关文章

  • 可以使用“ifconfig”块(reStructuredText)有条件地定义目标

    是否可以有条件地定义target https docutils sourceforge io docs ref rst restructuredtext html hyperlink targets在 reStructuredText 文件
  • 如何使用 Sphinx 标记引用记录的 Python 函数参数?

    我想在 Python 文档字符串中的其他位置引用先前记录的函数参数 考虑以下 诚然完全是人为的 示例 def foo bar Perform foo action param bar The bar parameter def nested
  • 在 Python Sphinx 中使用 automodule 不显示变量和类属性

    我想知道为什么在 Sphinx 中使用 automodule 指令时我无法看到类属性 即使属性有文档字符串 与 Django 设置常量相同 它们没有显示 I use automodule settings members show inhe
  • 让 Sphinx 替换文档字符串文本

    我正在 Sphinx 中记录类似于以下内容的代码 class ParentClass object def init self pass def generic fun self Call this function using run P
  • python的sphinx中var、cvar和ivar有什么区别?

    我正在阅读 sphinx 文档页面 讽刺的是发现关于 var ivar 和 cvar 之间差异的文档非常缺乏 我想知道是否有人可以解释内联代码中每个不同名称空间之间的区别 Example class foo object var str f
  • 使用“from x import *”记录文件

    sphinx 的 automodule 和其他自动功能可用于记录包含以下内容的模块from x import 声明不包含导入模块的所有文档 编辑 根据mzjn的观点 只要导入的方法 module 属性与模块名称不同 不应记录它们 然而 对于
  • 在 readthedocs 中构建随机失败

    Readthedocs 似乎有一个奇怪的问题 构建失败 没有任何明显的原因 在同一个提交 ID 上 构建一次失败 后来成功 Failure https readthedocs org projects opnfvdocsdemo build
  • 列表等数据结构类型的 Sphinx 文档字符串标准是什么?

    Sphinx 是否有支持的标准来记录不是简单的单个对象的参数或返回值类型 例如 在下面的例子中 arg1 是一个 str arg2 是一个 str 列表 arg3 是一个 str 或 int 如何在 Sphinx 中指定集合或复合类型 或者
  • 如何避免 ReST 表中的水平滚动条?

    我在 ReST 标记中有这个表 Option Line Kind Distinguishing Characteristic Reference The option name is call
  • Sphinx Pygments 词法分析器过滤器扩展?

    我有一种类似 Lisp 的语言 我想在 Sphinx 代码片段文档中强调使用 Pygments 我的方法是扩展现有的 CommonLispLexer 以使用 NameHighlightFilter 添加内置名称 但是 它不起作用 所以我一定
  • 带有标题的剩余图像网格?

    作为对此的扩展question https stackoverflow com questions 10219634 image grid in restructuredtext sphinx 如何使用 Sphinx 和 reStructu
  • 如何配置 Sphinx 有条件地排除某些页面?

    使用 Sphinx 生成文档时 我希望能够生成文档的两个版本 一个包含所有内容 另一个仅包含一组特定的页面 实现这一目标的最佳方法是什么 我可以编写一个构建脚本来移动文件来实现此目的 但如果有一种方法可以告诉 sphinx 在特定构建期间排
  • 用于多语言 API 的 Doxygen

    我的公司开发了一个用于工程程序的 API 它是用 C 开发的 但我们为以下语言创建了包装器 类似于 VB 的专有语言 MATLAB 和Python 目前 文档是由一堆脚本生成的 要保持 100 的完整性开始变得非常耗时 我想知道是否有一种方
  • 如何在 Windows 中使用 Sphinx 创建 PDF 文档

    我正在使用 Sphinx 在 Windows 中为我的 Python 项目创建文档 我需要生成 PDF 文档 我发现了很多关于如何在 Linux 中执行此操作的解释 但没有很好的解释如何在 Windows 中执行此操作 据我了解 我需要使用
  • Sphinx 扩展可在 Sphinx 中使用 GitHub markdown 表情符号吗?

    Problem 我一直在使用 Python Sphinx 文档 http www sphinx doc org 随着通用标志 http commonmark org 解析器 用于编写包含以 reStructuredText 和 Markdo
  • 将可点击的 SVG 图像插入 Sphinx 文档

    我有 SVG 图像文件 其中有多个节点 每个节点都与 URL 关联 如果我直接在浏览器中打开此文件 我可以单击每个节点 它将打开不同的 URL 但是 当我在 Sphinx 文档中使用这张图片时 它不起作用 图片作为一个整体呈现 所以我需要通
  • Furo Sphinx 主题在 API 文档中保留过多的大写字母

    我面临着这个问题中讨论的同样的问题 Furo Sphinx 主题在 API 文档中大写过多 https stackoverflow com questions 69873561 furo sphinx theme uppercases to
  • Sphinx:autodoc 无法导入模块

    我对狮身人面像有以下问题 我的项目结构是 project api init py rpc py v1 init py model py build source conf py Makefile 在conf py中我有 import os
  • Sphinx——结合自动模块和自动类

    除非我错过了什么 斯芬克斯的automodule只会记录模块的成员 而不记录该模块中定义的类的属性 有办法吗自动地得到的行为automodule and autoclass以这样的方式组合 我可以自动获取模块成员的文档and在该模块中找到的
  • 如何处理 ReST 中的两个破折号

    我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序 我希望能够记录命令行选项 例如 region像这样 region

随机推荐