Как стать автором
Обновить

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

Занятно :)
Спасибо за статью!

Использование docker'а здесь выглядит как из пушки по комарам или автор хотел блеснуть эффективным использованием контейнерной визуализации в сочетании с современной ИТ модой. Применение встроенного модуля в CPython venv на мой взгляд намного проще и понятнее, а так же не придётся набирать длинные команды вроде docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .

Ведь даже стандартная документация к Питону генерируется с помощью venv без всяких контейнеров.

Поверьте, автор не хотел ничем блеснуть =)

Просто, не являясь практикующим питонистом, я всего лишь воспользовался наиболее подходящим вариантом из предложенного разработчиками material for mkdocs в их документации.

Поэтому благодарю за интересное предложение!

Наверное, можно предложить и разработчикам mkdocs добавить такой вариант прямо на страницу getting started - а не только сослаться на подобный метод в одном из абзацев раздела troubleshooting-а.

UPDATE. Более подробное изучение темы показало, что venv будет менее удобен при наличии зависимостей от не python библиотек.

Например, использование того же плагина with-pdf требует наличия в системе пакетов pango, для русского языка ttf-ubuntu-font-family, а также некоторых других (полный список есть в статье) - и вот это всё придётся всё равно ставить в основную систему.

А в случае докера это всё-таки можно "спрятать" в образ.

Все наглядно и подробно описано, спасибо!

а вот интересно как во всё эот великолепие добавить картинки?

я бы мог предполодить что рядом с markdown документами могут лежать файлики и на них ставятся ссылки... но по крайнем мере в описании все примеры уводят в сетевые урлы

Спасибо за вопрос!

Вы абсолютно правы: картинки можно как hfcgjkfufnрасполагать рядом с файлом markdown, так и определять в отдельные папки, прописывая при этом в самом markdown относительные пути.

Я предпочитаю класть картинки в подпапку ./images.

Посмотрите пример в нашем репозитории https://gitlab.com/Rostelecom-IT/help-camera-rt/-/tree/master/desktop-app/docs/application_modes:

В файле index.md есть, к примеру, ссылка на картинку shortcut_internet_mode.png, расположенную в подпапке images. И вот как выглядит добавление картинки в самом файле:

![Обычный режим (онлайн, оффлайн)](./images/shortcut_internet_mode.png)

спасибо за уточнение!

сама инструкция замечательна - как для понимания контекста, так и как детальное описание шагов

Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.