Sphinx Alabaster主题目录没有在所有页面中显示

时间:2018-07-04 00:58:53

标签: python-sphinx

我试图在所有页面上显示目录。我的设置非常简单。在index.rst中,我有

Installation
============

Scripting
=========


.. toctree::
:maxdepth: 2
:caption: Contents:

class ASAT
""""""""""
.. toctree::
    :maxdepth: 2

    asat

    more class ...

在其他页面中,我有:

class asat.SomeClass
"""""""""""""""""""""
.. autoclass:: modeule.SomeClass
    :members:

    .. automethod:: __init__

为了显示目录,我更改了conf.py以反映:

html_sidebars = {
    '**': [
        'globaltoc.html',
        'relations.html',
        'searchbox.html'
    ]
}

但是,这样做时,index.rst中的嵌套内容都没有出现在任何TOC中。这是它的屏幕截图:

Imgur

如何从雪花石膏中获取原始/普通TOC出现在我的所有页面中?

1 个答案:

答案 0 :(得分:2)

根据installation docs,您需要在设置中添加navigation.html

html_sidebars = {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',
        'searchbox.html',
        'donate.html',
    ]
}

如果您使用的是Alabaster的变体,请查阅其文档。

编辑:

我刚刚注意到您的reStructuredText语法不正确。您需要缩进toctree的参数。

.. toctree::
    :maxdepth: 2
    :caption: Contents: