Question

我在Sphinx中制作了一系列设计文档，我希望将它们放在toctree中并将文档中的部分编号。我知道我可以使用.. sectnum::对子页面中的所有部分进行编号。然而，Sphinx / rst编号页面的标题（实际上只是第一部分），目录最终看起来像：

Table of Contents
    1 Design the First
    2 Design the Second

并且每个子页面看起来像：

1 Design the First
1.1 First Section
1.2 Second Section

我想要的是我的索引页面上的目录，其中只列出了标题

Table of Contents
    Design The First
    Design the Second

和看起来像

的子页面

Design the First
1 First Section
2 Second Section

有没有办法让一个标题显示在TOC以及子页面的顶部，而这个标题最终不是编号的部分？

Answer 1

我不知道你最终做了什么，但我想做同样的事情！我有以下设置：

index.rst

.. toctree::

   assignment
   library_api

我只希望作业部分有数字，所以要么可以做两个单独的toctree，一个使用:numbered:，要么放在文件的顶部

.. sectnum::
   :start: 0

当然，提到您提到的确切问题 - 我的顶级标题为Assignment Writeup，因此0以及小节中的所有内容均为0.x，例如

Assignment Writeup
==================

First Task
----------

Second Task
-----------

给出

0. Assignment Writeup
    0.1 First Task
    0.2 Second Task

事实证明，你可以轻松搞定。它使事情变得更加模块化，但是“增加了一层间接”。

现在我有assignment.rst和assignment_writeup.rst。 assignment.rst基本上只有一个标题和toctree：

Assignment Writeup
==================

.. toctree::
   :maxdepth: 4

   assignment_writeup

然后获取所有子部分并将它们放入assignment_writeup并“向上”其标题级别。所以我现在把所有的子部分和子部分做成子部分，然后将它们变成子部分。

.. sectnum::
   :start: 0

First Task
==========

^^^ === instead of --- now

Second Task
===========

我们现在终于有了

Assignment Writeup
    0. First Task
    1. Second Task

有点可疑，但这是我能实现它的唯一方法x0我想知道你在问这个和现在之间做了什么？希望有一天能有人看到这一点并从中受益！

注意：这会产生不良副作用。 Assignment Writeup显示在自己的页面上，只显示间接文档的链接。不确定哪个更诚实......