recommonmarkを使用してReadme.mdファイルをSphinxでレンダリングできます。しかし、複数のReadmeファイルを.rstファイルに入れようとすると、最初のファイルだけがドキュメントリンクからアクセスできます。.rstに複数の.mdファイルを表示できませんtoctree Sphinx
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:WARNING:toctreeを文書化する 参照が含まれている「キック/ KVM /テスト タイトルを持っていない/ README」:リンクが生成されません
情報をお寄せいただきありがとうございます!これで問題は解決しますが、ファイルは自動生成されます。 .rstから直接問題を修正する方法はありますか? – Strommer
いいえ。自動生成ツールの上流に移動して、ソースに見出しを設定するか、自動生成された.mdファイルにそのようなマークアップを含める必要があります。 –