如何使用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