Не удается отобразить несколько файлов .md в .rst toctree Sphinx

Я могу визуализировать мои файлы Readme.md в Sphinx, используя рекомендацию. Но когда я пытаюсь вставить несколько файлов Readme в дерево .rst файла, только к первому можно получить доступ по ссылке на документацию.

Kick! KVM
=========

Source Code: https://bitbucket-eng-rtp1.cisco.com/bitbucket/projects/KICK/repos/kickdb/browse/kick/kvm


ReadMe
------
.. toctree::
    :maxdepth: 2

    ./README.md

Tests ReadMe
------------
.. toctree::
    :maxdepth: 2

    ./tests/README.md


KVM Module Code
---------------

.. automodule:: kick.kvm.actions
    :members:
    :undoc-members:

Я вижу оба файла Readme в структуре папок, но ссылки не работают при попытке получить к ним доступ с визуализированной html-страницы.

Вот изображение структуры папок.

Любая помощь приветствуется, спасибо!

Вот ошибка, которая появляется в сборке Sphinx:

/workspace/kick_device2/kick/kvm/kvm.rst:16: ПРЕДУПРЕЖДЕНИЕ: toctree содержит ссылку на документ kick / kvm / tests / README, у которого нет заголовка: ссылка не будет создана


person Strommer    schedule 31.08.2017    source источник


Ответы (1)


Предупреждение указывает на то, что вам нужно добавить заголовок к файлу tests/README.md. Sphinx считает уровень h1 заголовком страницы. Из документации по синтаксису уценки:

# My Title

or

My Title
========
person Steve Piercy    schedule 31.08.2017
comment
Спасибо за информацию! Это решает проблему, но файлы создаются автоматически. Есть ли способ решить проблему прямо из файла .rst? - person Strommer; 05.09.2017
comment
Нет. Для настройки заголовков в исходном коде вам придется либо перейти к инструменту автогенерации, либо пост-обработать автоматически сгенерированный файл .md для включения такой разметки. - person Steve Piercy; 06.09.2017