6

我可以使用 recommonmark 在 Sphinx 中渲染我的 Readme.md 文件。但是当我尝试在 .rst 文件 toctree 中放入多个自述文件时，只能从文档链接访问第一个。

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 页面访问它们时，链接不起作用。

这是文件夹结构的图像。

任何帮助表示赞赏，谢谢！

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

/workspace/kick_device2/kick/kvm/kvm.rst:16：警告：toctree 包含对没有标题的文档“kick/kvm/tests/README”的引用：不会生成链接

4

1 回答 1

6

警告表明您需要为文件添加标题tests/README.md。Sphinx 将h1级别视为页面的标题。从降价语法文档：

# My Title

或者

My Title
========
于 2017-08-31T20:29:37.613 回答