通常使用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(使用前将#替换为@)