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

时间:2015-12-13 08:20:16

标签: python-sphinx restructuredtext read-the-docs

结构

项目的以下结构:

  • 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页面(页面没有{{1内容)。

即。有文件Subgroup1

group1/subgroup1.rst

呈现给:

want

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

1 个答案:

答案 0 :(得分:10)

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

对我来说有用的是创建引用包含子$ echo '{ "wines": [ { "name": "b", "price1": 30, "price2": 110 }, { "name": "a", "price1": 50, "price2": 1 }, { "name": "c", "price1": 40, "price2": 1130 } ] }' | jp 'min_by(wines, &min([price1,price2]))' { "price2": 1, "price1": 50, "name": "a" } 指令的文件的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