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

时间:2017-08-31 17:53:11

标签: python-3.x python-sphinx commonmark

我可以使用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'那没有   title:不会生成链接

1 个答案:

答案 0 :(得分:2)

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

# My Title

My Title
========