3

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

还有一个previousand next,但我真正想看到的是侧边栏中的一个 TOC,它显示了所有部分,当前部分已展开。

例如,主页(即 index.rst)将是“概览”并默认打开。简介和快速入门是 index.rst 的部分:

Overview
    Introduction
    Quickstart
    Credits
Tutorial
Contribute
Index
API
Search

“教程”将以next. When the 'Contribute' item is selected, the TOC is updated like so:

Overview
Tutorial
Contribute
    Install for development
    Style Guide
Index
API
Search

Search, Index,API应该链接到生成的页面,这些页面通常在 Sphinx 教程中像这样插入:

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

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

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

4

0 回答 0