Блог

Главная - Вопросы по программированию - Как сделать рендеринг readme.md в sphinx, который содержит относительный путь к некоторым изображениям

Как сделать рендеринг readme.md в sphinx, который содержит относительный путь к некоторым изображениям

#python #python-3.x #python-sphinx

#python #python-3.x #python-sphinx

Вопрос:

Я использую m2r2 для рендеринга html-документа с помощью sphinx. Моя структура папок

 project
  |_ docs
      |_ sphinx root
  |_ README.md
  |_ image_to_include_in_readme.png

README.md выглядит примерно так:

 # This is heading

Some text. refer to the image : [Image](image_to_include_in_readme.png)

Но это изображение не читается из корневой папки sphinx.

Я способен оказывать readme.md правильно используя mdinclude директиву в html, но изображения не отображаются. Я получаю WARNING: image file not readable:
Я знаю, что могу скопировать изображения в папку сборки, но я не хочу этого делать. Как мне это исправить?

Комментарии:

1. Является ли файл image_to_include_in_readme.md изображением или текстовым файлом markdown? Что у вас есть в вашем README.md , которое включает изображение? Как вы включаете README.md в свою документацию Sphinx?

2.Мой плохой. Это файл изображения. Я использую ..mdinclude директиву m2r2.

3. Я обновил вопрос. mdinclude предназначен для файлов markdown, но как мне связать изображения в нем?

4. «Я знаю, что могу скопировать изображения в папку сборки, но я не хочу этого делать». Вы должны. Sphinx отображает пути к изображениям относительно встроенных файлов.

5. Кажется связанным: github.com/miyakogi/m2r/issues/46