我正在使用 Sphinx用于记录 Python 项目并希望获得来自现有 .md 的内容.rst 内的文件显示文件。
(我已经设置了我的 conf.py 以允许 Markdown )。
例如，我有一个名为 tutorial.md 的文件.我也有 .rst文件如下:
ml
==
w2v
^^^
.. automodule:: package.ml.w2v
:members:
我希望能够包含指向
tutorial.md 的链接如下，使得tutorial.md的内容将在渲染时显示在文件中。这可以通过以下方式实现:ml
==
Tutorial
--------
.. include:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
但是，生成的内容看起来很糟糕，因为它不会将 Markdown 呈现为 Markdown 。
我意识到我可以通过将整个文档编写为
.md 来避免这个问题。 ，但是这个练习给我留下了以下问题:是否可以有
.md内容呈现为 Markdown ，在 .rst 内文件？
最佳答案
笔记mr2扩展似乎被放弃了。您可以使用主动维护叉 m2r2反而。
原答案:
试试 M2R狮身人面像扩展。
https://github.com/miyakogi/m2r#sphinx-integration
安装m2r并更改conf.py后，只需更改.. include至 .. mdinclude会很好用。
ml
==
Tutorial
--------
.. mdinclude:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
关于markdown - 在 .rst 文件中渲染 Markdown 文件的输出，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/45967058/