私はSphinx
をPythonプロジェクトのドキュメントとして使用していて、既存の.md
ファイルのコンテンツを.rst
ファイル内に表示したいと考えています。 (私はすでにconf.py
をマークダウンできるように設定しています)。.rstファイル内のmarkdownファイルの出力をレンダリングする
たとえば、tutorial.md
というファイルがあります。 tutorial.md
の内容は、レンダリング時にファイルに表示されるように、次のように
ml
==
w2v
^^^
.. automodule:: package.ml.w2v
:members:
私はtutorial.md
へのリンクを含めることができたいと思います:次のように私はまた.rst
ファイルを持っています。これは、次のように達成することができます:それは値下げとして値下げをレンダリングしないよう
ml
==
Tutorial
--------
.. include:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
はしかし、結果のコンテンツは、悪く見えます。
私は.md
として全体のドキュメントを書くことで、この問題を回避することができます実現しますが、この演習では、次の質問を私に残している:
はそれがの内、.md
コンテンツをマークダウンとしてレンダリングすることは可能です.rst
ファイルですか?
レンダリングされたコンテンツは悪く見えますが、マークダウンとしてレンダリングされませんが、何を*レンダリングしますか?もう少し情報が役立つだろう。エラーメッセージや警告メッセージはありますか? –
また、Pythonパッケージ[recommonmark](http://www.sphinx-doc.org/en/stable/markdown.html)など、Sphinxブリッジをインストールして設定しましたか?マークダウンには多くの味があります。 –
IIRC、それは不可能です。 Docutils(最初のパーサー)は、Markdownについての知識がありません。また、 'include'はdocutils特有の機能です。だから、Sphinxは与えられたファイルがMarkdownではなく最初にあると判断すると、そのファイルは最初にDocutilsに渡され、Markdownオプションはもはや存在しません。少なくともそれは私の理解です。 – Waylan