Str*_*mer 6 python-3.x sections python-sphinx commonmark toctree
我可以使用 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:
Run Code Online (Sandbox Code Playgroud)
我可以在文件夹结构中看到两个自述文件,但是当尝试从呈现的 html 页面访问它们时,链接不起作用。
这是文件夹结构的图像。
任何帮助表示赞赏,谢谢!
这是在 Sphinx 构建中弹出的错误 -
/workspace/kick_device2/kick/kvm/kvm.rst:16: 警告:toctree 包含对没有标题的文档“kick/kvm/tests/README”的引用:不会生成链接
警告表明您需要为文件添加标题tests/README.md。Sphinx 将h1级别视为页面的标题。从降价语法文档:
# My Title
Run Code Online (Sandbox Code Playgroud)
或者
My Title
========
Run Code Online (Sandbox Code Playgroud)
| 归档时间: |
|
| 查看次数: |
1694 次 |
| 最近记录: |