python-sphinx - 如何使 toctree 链接像引用小节一样引用单独的文件

Question

结构

项目结构如下：

• index.rst

  MyProject
  =========
  
  Contents:
  
  .. toctree::
  
     group1
  

• group1.rst

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

渲染到（点击Group1->后Subgroup2）：

如您所见，它打开Group1页面并链接到Subgroup2部分。

想

我想在左侧有相同的内容（打开Group1并Subgroup2选择），但在右侧我只想看到Subgroup2页面（没有Subgroup1内容的页面）。

即有文件group1/subgroup1.rst：

Subgroup2
=========

Subgroup2 contents

渲染到：

如何实现？这是一个深度为 2 的简单示例，那么深度 3-4 呢？

Answer 1

您需要每页内容都有一个文件。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