无法在 .rst toctree Sphinx 中显示多个 .md 文件

Question

我可以使用 recommonmark 在 Sphinx 中呈现我的 Readme.md 文件。但是，当我尝试将多个自述文件放入 .rst 文件 toctree 时，只能从文档 link.

访问第一个文件

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:

我可以在文件夹结构中看到这两个自述文件，但是当尝试从呈现的 html 页面访问它们时 link 不起作用。

这是文件夹结构的图片。

感谢任何帮助，谢谢！

这是在 Sphinx 构建中弹出的错误 -

/workspace/kick_device2/kick/kvm/kvm.rst:16: WARNING: toctree contains reference to document 'kick/kvm/tests/README' that doesn't have a title: no link will be generated

Answer 1

警告表明您需要为文件添加标题tests/README.md。 Sphinx 将 h1 级别视为页面的标题。来自 markdown syntax documentation:

# My Title

或

My Title
========

无法在 .rst toctree Sphinx 中显示多个 .md 文件

Can't display multiple .md files in .rst toctree Sphinx

python-3.x

python-sphinx

sections

toctree

commonmark