將模塊表添加到ReadTheDocs側欄

Question

我試圖獲得一些基本文檔，以漂亮的在線格式發佈on readthedocs。

理想情況下，我希望側邊欄包含我的模塊列表。我碰到this answer，這似乎解決了我的問題 - 但實施它完全沒有。

除此之外，我得到的印象是它不僅僅是模塊（或者我試圖重現的例子，genindex）列表沒有被添加 - 而是相關列表甚至沒有被構建。

我基於這樣一個事實，即http://labbookdb.readthedocs.io/modules.html和http://labbookdb.readthedocs.io/genindex.html似乎都不存在。

最後，我設法讓genindex.html和modules.html在本地構建 - 但即使如此，我也無法將它們包含在側邊欄中。

Answer 1

首先嚐試更新您的index.rst。它目前只有一個條目，../README.rst，所以這是唯一被建立的東西。您還需要包含一個toctree directive和其他文件。

將這個概念應用到側欄，就像你在研究中發現的那樣，而不是index.rst，應該這樣做。

也有一些主題可以做你想做的，開箱即用。看看https://cloud-sptheme.readthedocs.io/en/latest/會做你想做的。如果沒有，只要搜索「獅身人面像主題」，並探索。