2017-08-30 5 views
2

私は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ファイルですか?

+1

レンダリングされたコンテンツは悪く見えますが、マークダウンとしてレンダリングされませんが、何を*レンダリングしますか?もう少し情報が役立つだろう。エラーメッセージや警告メッセージはありますか? –

+1

また、Pythonパッケージ[recommonmark](http://www.sphinx-doc.org/en/stable/markdown.html)など、Sphinxブリッジをインストールして設定しましたか?マークダウンには多くの味があります。 –

+1

IIRC、それは不可能です。 Docutils(最初のパーサー)は、Markdownについての知識がありません。また、 'include'はdocutils特有の機能です。だから、Sphinxは与えられたファイルがMarkdownではなく最初にあると判断すると、そのファイルは最初にDocutilsに渡され、Markdownオプションはもはや存在しません。少なくともそれは私の理解です。 – Waylan

答えて

3

try M2Rスフィンクスエクステンション。

https://github.com/miyakogi/m2r#sphinx-integration

後にうまく機能だけ.. mdinclude.. includeを変更、M2Rと変更conf.pyをインストールします。

+0

すばらしい拡張機能は間違いありません。ありがとう! –

関連する問題