Sphinx将Markdown文件中的标题添加到文档结构中

Question

我已将Sphinx配置为使用markdown文件。

在我的index.rst文件中

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   documents/Markdown

在Markdown.md我有

# Markdown

## H2 Heading

当我渲染主页面时，我会在toctree中出现H2标题。

我有我的toctree的其他部分，我想要一个：maxdepth超过1.为什么sphinx读取H2标题作为toctree的一部分，我怎么能让它停止这样做，而不必设置：maxdepth到1？

Answer 1

@mzjn部分回答了你的要求。就个人而言，我不确定这在Markdown中是如何完成的，但我认为它与reStructuredText类似。不幸的是，目前没有直观的方法来做到这一点。但是，您可以执行以下操作：

.. toctree::
   :maxdepth: 1

   documents/Markdown1

.. toctree::
   :maxdepth: 2

   documents/Markdown2

这将输出所需的行为，但在这种情况下，您的两棵树之间会有一些垂直间距。要么你这样做，要么你可以使用：

.. toctree::
   :maxdepth: 2

   documents/Markdown1
   documents/Markdown2

但是你需要将你想要显示的内容转移到较低级别（例如H3）。

Answer 2

maxdepth选项表示TOC的所需深度。

如果你使用:maxdepth: 1，“H2标题”应该消失。