微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何使用glob更改toctree中的标题?

如何解决如何使用glob更改toctree中的标题?

我在狮身人面像项目中使用了带有glob选项的toctree,并且我想使用Titlesonly作为toctree的选项来显示文件的H1或文件名不同的标题

这是我的代码一个简短提示

在index.md中有我项目的README.md文件

```{toctree}
---
maxdepth: 1
glob:
---
src/*/*

我想显示“项目根目录”,例如“ audit”,而不是文件“ Projet audit @shared”的标题

这是README.md的一个提示

# Projet audit @shared

* Project Root: `audit`

解决方法

您不能使用glob指定文档标题。 showing custom titles in reST is described in the documentation的语法。

条目

toctree中的文档标题将自动从引用文档的标题中读取。如果那不是您想要的,则可以使用类似的语法来指定一个明确的标题和目标,以重新建立超链接(和Sphinx的cross-referencing syntax)。看起来像:

.. toctree::

    intro
    All about strings <strings>
    datatypes

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。