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

标签 python-sphinx sidebar restructuredtext read-the-docs toctree

结构

该项目的结构如下:

  • 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内容的页面)。

    IE。有文件group1/subgroup1.rst:
    Subgroup2
    =========
    
    Subgroup2 contents
    

    呈现给:

    want

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

    最佳答案

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

    对我有用的是创建toctree指令,该指令引用包含sub-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
    

    关于python-sphinx - 如何使toctree链接像引用小节一样引用单独的文件,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/34249244/

    相关文章:

    javascript - Bootstrap 3 重叠内容问题。侧边栏折叠按钮

    restructuredtext - 是否可以在 reST 中从小节级别开始自动进行节标题编号?

    python - 如何在列表元素中添加 anchor

    html - 为什么图像缩放在生成 html 文件时在 reStructuredText 中不起作用?

    python-sphinx - 狮身人面像导入父目录rst文件?

    python-sphinx - 如何配置用于 :menuselection:? 的分隔符

    GitLab 页面,使用 sphinx 生成的文档

    python - 如何部署使用 Sphinx 制作的博客

    jquery 修复滚动时侧边栏,直到底部

    css - 侧边栏组件的完美位置类型是什么?