Блог

Главная - Вопросы по программированию - Как использовать `m2r_parse_relative_links` в m2r2?

Как использовать `m2r_parse_relative_links` в m2r2?

#markdown #python-sphinx #relative-path

#markdown #python-сфинкс #относительный путь

Вопрос:

У меня есть изображение в моем, README.md которое я хотел бы отобразить в моих документах sphinx ( /docs/readme.rst ). Может кто-нибудь показать мне, как использовать m2r_parse_relative_links , чтобы заставить это работать?

m2r Документация не содержит никакой информации о том, как использовать m2r_parse_relative_links опцию; в ней указано только, что она существует. Насколько мне известно, я полагаю, что этот параметр может быть установлен в conf.py как

 m2r_parse_relative_links = True

Я пытался это сделать в своей собственной документации sphinx, и у меня это не работает. Структура каталогов моего проекта такова:

  --project
|   -- __init__.py
|   -- index.rst
|   -- Makefile
|   -- make.bat
|   -- readme.rst
|   -- docs/
|       -- _build/
|       -- _statics/
|       -- _templates/
|       -- imgs/
|           -- test.png
|       -- 
|   -- src/
|       -- main.py
|       -- README.md

README.md Содержит изображение

 ![Test](docs/imgs/test.png)

readme.rst имеет

 .. mdinclude:: ./src/README.md

и conf.py имеет

 m2r_parse_relative_links = True

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

1. Пожалуйста, покажите, что вы пробовали, после прочтения документации: pypi.org/project/m2r

2. Настройка Sphinx выполняется в conf.py , а не в readme.rst . Вы не говорите, настроили ли вы Sphinx для анализа файлов markdown, установили ли вы или настроили m2r или создали ли вы свои документы. Пожалуйста, укажите эти детали.

3. @StevePiercy Я допустил ошибки в своем репосте. Я исправил это. Sphinx настроен для анализа файлов markdown. conf.py включает source_suffix = {".rst": "restructuredtext", ".md": "markdown"}

4. @StevePiercy Ты знаешь, как заставить это работать?

5. Согласно github.com/crossnox/m2r2#features , m2r_parse_relative_links это «опция для разбора относительных ссылок в директивах ref и doc». В нем ничего не говорится об изображениях.