如何在sphinx中显示所有部件的侧边栏TOC

时间:2015-05-31 10:24:50

标签: documentation python-sphinx

也许只是我,但我经常很难理解和导航 基于Sphinx的文档,因为目录只显示了 当前页面的结构(至少在标准主题中)。

还有previousnext,但我真正希望看到的是 侧栏中显示所有部分的TOC,当前部分已展开。

例如,主页面(即index.rst)将是'概述'并打开 默认。简介和快速入门是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`

有没有一种简单的方法可以在Read the Docs上实现这一点, 或者任何人都可以指向现有模板吗?

0 个答案:

没有答案