【问题标题】:Can Sphinx Section Numbering Skip Certain Sections (like a title)?狮身人面像部分编号可以跳过某些部分(如标题)吗?
【发布时间】:2017-01-31 21:20:29
【问题描述】:

我正在 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

有没有办法让标题显示在目录中以及最终不是编号部分的子页面的顶部?

【问题讨论】:

    标签: python-sphinx sections toctree


    【解决方案1】:

    我不知道你最终做了什么,但我想做同样的事情!我有以下设置:

    index.rst
    
    .. toctree::
    
       assignment
       library_api
    

    我只希望分配部分有数字,因此可以使用:numbered: 完成两个单独的toctree,或者放在文件的顶部

    .. 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.rstassignment_writeup.rstassignment.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 我想知道你在问这个和现在之间做了什么?希望有一天有人会看到这一点并从中受益!

    注意:这有不良的副作用。作业记录显示在它自己的页面上,只有指向间接文档的链接。老实说,不确定哪个更糟...

    【讨论】:

    • 五年后没有解决方案?
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-07-02
    • 2013-11-10
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2013-02-08
    相关资源
    最近更新 更多