我正在使用Sphinx
来记录Python项目,并希望将现有.md
文件中的内容显示在.rst
文件中。
(我已经设置了conf.py
以允许降价。
例如,我有一个名为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:
但是,结果内容看起来很糟糕,因为它不会将降价显示为降价。
我意识到我可以通过将整个文档编写为.md
来避免这个问题,但是这个练习给我留下了以下问题:
是否可以将.md
内容呈现为.rst
文件中的降价,
答案 0 :(得分:8)
尝试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: