Включите мой README с уценкой в ​​Sphinx. ⇐ Python

[Anonymous]

Я хотел бы включить README.md моего проекта в документацию по Sphinx, например:
Может ли sphinx ссылаться на документы, которые не расположены в каталогах ниже корневого документа?
- что что в полученной html-документации Sphinx я нажимаю на ссылку в оглавлении на странице приветствия и попадаю в README.md.

Для этого документ создается readme_link.rst, содержащий строки

Код: Выделить всё

Readme File
-----------

.. include:: ../../README.md

и я добавляю строку

Код: Выделить всё

README 

в дерево содержимого index.rst.
При этом мой README.md не анализируется как Markdown, но просто напечатан на странице как есть.

Я подумал, что альтернативной идеей может быть использование файла уценки readme_link.md, но есть нет возможности включать файлы с уценкой.

Как я могу проанализировать мой README.md как уценку?

(Конечно, я не хочу сначала переписывать его как .)

Почему m2r не работает

Я пытался проследить вывод Render из файла уценки внутри файла .rst, но это не работает. В моем README.md есть заголовки типа

Код: Выделить всё

# First heading

some text

## Second heading 1

some text

## Second heading 2

some text

и я получаю сообщение об ошибке ПРЕДУПРЕЖДЕНИЕ: ../README.md:48: (СЕРЬЕЗНЫЙ/4) Несоответствие уровня заголовка:. Я понимаю, что означает «несоответствие уровня заголовка»? что мне нужно использовать другие символы - но, прочитав их, я понял, что ответ относится к первым символам. Это означало бы, что мой файл readme с уценкой на самом деле не был преобразован в первый.

PS: Кто-то еще, кто пробовал что-то подобное,
https: //muffinresearch.co.uk/selectically-включая-parts-readme-rst-in-your-docs/

Подробнее здесь: https://stackoverflow.com/questions/462 ... nto-sphinx