从sphinx中的侧边栏删除多余的toctree

问题描述 投票:0回答:1

编辑:另一篇文章似乎相关

我正在使用 fulltoc 扩展在侧边栏中显示目录。

全局目录在全局index.rst 文件中定义。它实际上是由一系列

toctree
组成的:

.. toctree::
   :caption: Getting Started

   gettingStarted/overview
   gettingStarted/section1
   gettingStarted/section2

.. toctree::
   :caption: Next Large section

   group2/overview
   group2/section1
   group2/etc

overview.rst
包含每个部分的描述以及后续部分的目录树。在文件夹
gettingStarted
中,该文件如下所示:

Overview
========

This is a description of the section.

.. toctree::

   section1
   section2

问题是,当查看页面时

gettingStarted/overview
侧边栏显示子目录,这会产生冗余条目:

开始使用

  • 概述
    • 第1节
    • 第2节
  • 第1节
  • 第2节

我更想要的地方

开始使用

  • 概述
  • 第1节
  • 第2节

一种解决方法是降低

:maxdepth:
,但是当从某个部分(例如 gettingStarted/section1)阅读时,侧边栏将不会展开子部分。

我还找到了

rubric
指令,但不知道如何使其在
toctree
上工作。

如何防止子目录被索引到全局目录中?

python python-sphinx sidebar restructuredtext toctree
1个回答
1
投票

我今天发现这个扩展似乎可以解决问题:https://github.com/executablebooks/sphinx-remove-toctrees

© www.soinside.com 2019 - 2024. All rights reserved.