Sphinx 不会为标题生成侧边栏目录

我正在努力处理 Sphinx 生成的文档中的侧边栏目录。

我只想在我的文档左侧有一种自动生成的索引树。相反,我只看到空白标题:(

http://img2.mukewang.com/61409c710001ba8809370897.jpg

我希望你不介意目标文档是波兰语)


我的 index.rst 文件:


.. SIMail documentation master file, created by

   sphinx-quickstart on Mon Nov 26 12:38:31 2018.

   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.


Welcome to SIMail docs!

=======================


.. toctree::

   :numbered:


Providers

==============


.. automodule:: Providers

   :members:


Connection managers

===================


.. automodule:: ConnectionManagers

   :members:



Indices and tables

******************


* :ref:`genindex`

* :ref:`modindex`

* :ref:`search`

我一直在寻找诸如“Sphinx 不会在侧边栏上生成索引”之类的问题,但我什么也没找到。看起来我省略了一些小细节。reST 中是否有特殊命令可以强制 Sphinx 在侧边栏上生成索引列表?

我找到了我的问题的部分答案,即使用sphinx-autodoc为所有模块生成单独的文件。但看起来问题在于,Sphinx 在从 index.rst 构建目录时会忽略所有标题

简单来说,我希望导航列表包含指向 index.rst 中所有标题的链接,与本教程示例中的方式相同。作者似乎只放了带有源文件的部分。并且他可以自动生成导航到 index.rst 中的所有标题。为了说明我的问题,我附上了另一张图片:

http://img3.mukewang.com/61409c8a0001caea20000687.jpg

请查看示例的 index.rst。文件中存在的每个标题都在导航中生成了链接。


慕码人2483693
浏览 457回答 2
2回答

拉风的咖菲猫

就我而言,这只是添加的问题.. toctree::   :hidden:   index在我的 index.rst 文件中。

皈依舞

您需要html_sidebars根据其文档为 Alabaster 主题添加显式设置:无论哪种方式,添加显式html_sidebars设置以便加载 Alabaster 的自定义侧边栏模板:    html_sidebars = {        '**': [            'about.html',            'navigation.html',            'relations.html',            'searchbox.html',            'donate.html',        ]    }
打开App,查看更多内容
随时随地看视频慕课网APP

相关分类

Python