Sphinx Alabaster theme TOC отображается не на всех страницах - PullRequest
Новая
       90

Sphinx Alabaster theme TOC отображается не на всех страницах

0 голосов
/ 04 июля 2018

Я пытаюсь показать содержание на всех своих страницах. Моя установка довольно проста. В 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 не обнаруживается ни в одном из оглавлений. Вот скриншот того, как это выглядит:

Imgur

Как я могу получить оригинальное / нормальное оглавление от алебастра для отображения на всех моих страницах?

1 Ответ

0 голосов
/ 04 июля 2018

В соответствии с установочными документами , вам необходимо добавить navigation.html к настройке. 

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

Если вы используете вариант алебастра, обратитесь к их документации.

EDIT:

Я только что заметил, что ваш синтаксис reStructuredText неверен. Вам нужно сделать отступ для параметров toctree. 

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