如何在狮身人面像中显示所有部件的侧栏TOC

也许这只是我自己,但我经常很难理解和浏览基于Sphinx的文档,因为Table Of Contents只显示当前页面的结构(至少在标准主题中)。

还有一个previousnext ,但是我真正想看到的是,显示所有的部件,以扩大目前部分侧边栏TOC。

例如,主页面(即index.rst)将是'Overview'并且默认打开。 简介和快速入门是index.rst的部分:

Overview
    Introduction
    Quickstart
    Credits
Tutorial
Contribute
Index
API
Search

'教程'将作为next提供。 当选择'Contribute'项目时,TOC会更新如下:

Overview
Tutorial
Contribute
    Install for development
    Style Guide
Index
API
Search

SearchIndexAPI应链接到生成的页面,通常在Sphinx教程中这样插入:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

阅读文档有没有简单的方法来实现这一点,或者任何人都可以指向现有的模板?

链接地址: http://www.djcxy.com/p/84129.html

上一篇: How to display a sidebar TOC for all parts in sphinx

下一篇: Multiple Levels of Toctree's in Python