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



我在我的sphinx项目中使用了一个带有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指定文档标题。文档中介绍了在reST中显示自定义标题的语法。

条目

toctree中的文档标题将自动从引用文档的标题中读取。如果这不是你想要的,你可以使用类似于reST超链接的语法(以及Sphinx的交叉引用语法(来指定一个明确的标题和目标。这看起来像:

.. toctree::
intro
All about strings <strings>
datatypes

相关内容

  • 没有找到相关文章

最新更新