Вывод рендера из файла markdown внутри.первый файл
Я использую 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:
Однако результирующий контент выглядит плохо, так как он не отображает markdown как markdown.
Я понимаю, что могу избежать этой проблемы, написав всю документацию как.md
, но это упражнение оставило меня со следующим вопросом:
Возможно ли, чтобы содержимое .md
отображалось как markdown, внутри файла .rst
?
1 ответ:
Попробуйте расширение 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: