从 .rst 文件中的 markdown 文件渲染输出
Render output from markdown file inside .rst file
我正在使用 Sphinx 来记录 Python 项目，并希望在 .rst 文件中显示现有 .md 文件的内容。
（我已经设置了 conf.py 以允许降价）。
例如，我有一个名为 tutorial.md 的文件。我还有一个 .rst 文件如下：
ml
==
w2v
^^^
.. automodule:: package.ml.w2v
:members:
我希望能够包含一个 link 到 tutorial.md，如下所示，这样 tutorial.md 的内容将在渲染时显示在文件中。这可以通过以下方式实现：
ml
==
Tutorial
--------
.. include:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
但是，生成的内容看起来很糟糕，因为它没有将降价呈现为降价。
我意识到我可以通过将整个文档写成 .md 来避免这个问题，但是这个练习给我留下了以下问题：
是否可以将 .md 内容呈现为 markdown，在 .rst 文件中？
注意
mr2 扩展似乎被放弃了。您可以改用积极维护的分支 m2r2。
原答案：
试试 M2R sphinx 扩展。
https://github.com/miyakogi/m2r#sphinx-integration
安装m2r并更改conf.py后，只需将.. include更改为.. mdinclude即可。
ml
==
Tutorial
--------
.. mdinclude:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
我正在使用 Sphinx 来记录 Python 项目，并希望在 .rst 文件中显示现有 .md 文件的内容。
（我已经设置了 conf.py 以允许降价）。
例如，我有一个名为 tutorial.md 的文件。我还有一个 .rst 文件如下：
ml
==
w2v
^^^
.. automodule:: package.ml.w2v
:members:
我希望能够包含一个 link 到 tutorial.md，如下所示，这样 tutorial.md 的内容将在渲染时显示在文件中。这可以通过以下方式实现：
ml
==
Tutorial
--------
.. include:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
但是，生成的内容看起来很糟糕，因为它没有将降价呈现为降价。
我意识到我可以通过将整个文档写成 .md 来避免这个问题，但是这个练习给我留下了以下问题：
是否可以将 .md 内容呈现为 markdown，在 .rst 文件中？
注意
mr2 扩展似乎被放弃了。您可以改用积极维护的分支 m2r2。
原答案：
试试 M2R sphinx 扩展。
https://github.com/miyakogi/m2r#sphinx-integration
安装m2r并更改conf.py后，只需将.. include更改为.. mdinclude即可。
ml
==
Tutorial
--------
.. mdinclude:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members: