在sphinx

时间:2017-08-23 18:17:22

标签: python python-sphinx restructuredtext

修改:this other post似乎相关

我使用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包含每个部分的说明以及后续部分的toctree。在文件夹gettingStarted中,此文件如下所示:

Overview
========

This is a description of the section.

.. toctree::

   section1
   section2

问题在于,当查看页面gettingStarted/overview时,侧边栏会显示子toc,这会产生冗余条目:

  

入门

     
      
  • 概述      
        
    • SECTION1
    •   
    • 第2节
    •   
  •   
  • SECTION1
  •   
  • 第2节
  •   

我宁愿拥有

  

入门

     
      
  • 概述
  •   
  • SECTION1
  •   
  • 第2节
  •   

一种解决方法是降低:maxdepth:,但是当从一个部分(例如gettingStarted / section1)读取时,侧边栏不会展开子部分。

我还找到了rubric指令,但无法弄清楚如何让它在toctree上运行。

如何防止子TOC被索引到全局TOC?

0 个答案:

没有答案