如何使toctree链接引用到单独的文件,就像它引用子节一样。

12

结构

该项目的结构如下:

  • index.rst

    MyProject
    =========
    
    Contents:
    
    .. toctree::
    
       group1
    
  • group1.rst

    Group1
    ------
    
    Subgroup1
    =========
    
    Subgroup1 contents
    
    Subgroup2
    =========
    
    Subgroup2 contents
    

呈现为(点击 Group1 -> Subgroup2 后):

clicked-on-subsection

您可以看到它打开了Group1页面,并链接到Subgroup2部分。

想要的效果

我希望在左侧看到相同的效果(打开Group1并选择Subgroup2),但在右侧,我只想看到Subgroup2页面(不包含Subgroup1内容的页面)。

即拥有文件group1/subgroup1.rst

Subgroup2
=========

Subgroup2 contents

呈现给:

want

如何实现?这是一个深度为2的简单示例,那么深度为3-4怎么办?

1个回答

21

每页内容需要一个文件。Sphinx不会将文件分成多个页面。

对我来说有效的做法是创建toctree指令,该指令引用包含子toctree指令的文件。我喜欢在目录中创建子组,但您也可以在一个目录中完成这个操作。

index.rst

MyProject
=========

Contents:

.. toctree::

   group1/index

group1/index.rst:

Group1
======

.. toctree::

   subgroup1
   subgroup2

group1/subgroup1.rst:

Subgroup1
=========

Subgroup1 contents

group1/subgroup2.rst:

Subgroup2
=========

Subgroup2 contents

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接