使用toctree时,防止Python Sphinx中的子部分嵌套

Question

我在构建我的Sphinx用户指南时遇到了问题.我想通过一个包含章节标题和概述的主登陆页面(index.rst)来形成章节,然后分开包含在不同文件中的子章节(part1.rst,part2.rst).我正在尝试使用"toctree"来插入单独的子部分,但是我遇到了一个嵌套问题,我的toctree被吸入了我的概述部分.(注意:我没有使用该..include::指令,因为我希望不同网页上显示的子节顺序链接.我也希望结构正确,以便它们在UG的pdf渲染版本中很好地布局).

index.rst

Chapter 3                                                
===============================                                                 

Overview                                                                        
--------                                                                        

Yadda yadda yadda.

.. toctree::                                                                    
   :hidden:                                                                     

   part1                                                                        
   part2

part1.rst

Part 1
------

This part is all about yadda.

part2.rst

Part 2
------

More yadda.

我希望得到的结构是:

Chapter 3
  - overview
  - part 1
  - part 2

但我得到的是

Chapter 3
  - overview
    - part 1
    - part 2

我在文件底部包含的toctree似乎属于"概述"部分,而不是在主章节上下文中运行.我尝试在文件的顶部插入toctree,但后来我得到了这个顺序:

Chapter 3
  - part 1
  - part 2
  - overview

似乎必须有一种方法可以正确地做到这一点,但我无法在Sphinx网站或SO上找到任何东西.任何帮助表示赞赏.

Answer 1

我遇到了完全相同的问题，找不到很好的解决方案。唯一的选择似乎是删除副标题（上例中的“概述”）或将其标记为标题，例如

.. rubric:: Overview

这意味着它不会包含在 TOC 中。应该可以将样式应用到 rubric 使其看起来像一个子标题，但这样做感觉有点像黑客。