Ran*_*ndy 5 sections python-sphinx toctree
我正在 Sphinx 中制作一系列设计文档,我想将它们一起包含在 a 中toctree,并对文档中的部分进行编号。我知道我可以用来.. sectnum::对子页面中的所有部分进行编号。然而,Sphinx/rst 为页面的标题(实际上只是第一部分)编号,目录最终看起来像:
Table of Contents
1 Design the First
2 Design the Second
Run Code Online (Sandbox Code Playgroud)
每个子页面看起来像:
1 Design the First
1.1 First Section
1.2 Second Section
Run Code Online (Sandbox Code Playgroud)
我想要的是我的索引页上的目录,它只列出了标题
Table of Contents
Design The First
Design the Second
Run Code Online (Sandbox Code Playgroud)
和子页面看起来像
Design the First
1 First Section
2 Second Section
Run Code Online (Sandbox Code Playgroud)
有没有办法让标题显示在目录中以及子页面的顶部,但最终不会成为编号部分?
我不知道你最终做了什么,但我想做同样的事情!我有以下设置:
index.rst
.. toctree::
assignment
library_api
Run Code Online (Sandbox Code Playgroud)
我只希望分配部分有数字,因此可以使用toctree或将其:numbered:放在文件顶部
.. sectnum::
:start: 0
Run Code Online (Sandbox Code Playgroud)
当然给出你提到的确切问题——我的顶级标题是Assignment Writeup,所以那就是0,它下面的小节中的所有内容都是0.x 例如
Assignment Writeup
==================
First Task
----------
Second Task
-----------
Run Code Online (Sandbox Code Playgroud)
给出
0. Assignment Writeup
0.1 First Task
0.2 Second Task
Run Code Online (Sandbox Code Playgroud)
事实证明,有一个简单的技巧可以实现。它使事情比可能期望的更加模块化,但是“添加了一个间接层”。
所以现在我有assignment.rst和assignment_writeup.rst。 assignment.rst 基本上只是有一个标题和一个toctree:
Assignment Writeup
==================
.. toctree::
:maxdepth: 4
assignment_writeup
Run Code Online (Sandbox Code Playgroud)
然后将所有子部分放入其中并assignment_writeup“向上转换”其标题级别。所以我现在将所有小节设为节,然后将它们细分为子节。
.. sectnum::
:start: 0
First Task
==========
^^^ === instead of --- now
Second Task
===========
Run Code Online (Sandbox Code Playgroud)
现在我们终于有了
Assignment Writeup
0. First Task
1. Second Task
Run Code Online (Sandbox Code Playgroud)
有点可疑,但这是我实现它的唯一方法x0我想知道你在问这个和现在之间做了什么?希望有一天有人会看到这一点并受益!
注意:这会产生不良副作用。作业写作显示在其自己的页面上,仅包含指向间接文档的链接。老实说,不确定哪个更糟糕......