Как использовать сторонние плагины\расширения Python?

Я прочитал документы что только несколько плагинов предварительно установлены в виртуальной среде, где происходит сборка. Как я могу использовать службу чтения документов с пользовательскими плагинами?

Я использую mkdocs для создания небольшой документации, в файле конфигурации mkdocs.yml я добавил следующие расширения:

markdown_extensions:
    - smarty

    - admonition

    #https://pythonhosted.org/Markdown/extensions/abbreviations.html
    - abbr

    #https://pythonhosted.org/Markdown/extensions/definition_lists.html
    - def_list

    #https://pythonhosted.org/Markdown/extensions/footnotes.html
    - footnotes

    #https://facelessuser.github.io/pymdown-extensions/
    - pymdownx.emoji:
        emoji_generator: !!python/name:pymdownx.emoji.to_png

    - pymdownx.details
    - pymdownx.superfences
    - pymdownx.caret
    - pymdownx.mark

В локальной среде предварительный просмотр с mkdocs serve работает нормально, при развертывании для чтения документов (через подключенный репозиторий github) сборка завершается сбоем, потому что не может найти плагины pymdownx, но я думал, что они будут автоматически получены RTD кроме плагинов по умолчанию, присутствующих в среде сборки.


person Maxiride    schedule 13.09.2017    source источник
comment
Не относится к RTD, но если кто-то зайдет сюда с другим вопросом, обязательно pip install pymdown-extensions   -  person alttag    schedule 24.08.2019


Ответы (1)


Насколько мне известно, Read the Docs (RTD) не поддерживает использование сторонних расширений. На самом деле RTD поддерживает только MkDocs версии 0.14. Однако с тех пор у MkDocs было несколько дополнительных выпусков (в настоящее время до 0.16), в каждом из которых было исправлено несколько ошибок и добавлены различные функции.

RTD уникален среди хостов для MkDocs. Для всех других хостов вам необходимо создать сайт локально перед отправкой на хост. Это позволяет вам убедиться, что у вас есть среда, подходящая для вашей сборки. Однако RTD строит сайт на своих серверах, что означает, что вы застряли в их среде, которая может соответствовать или не соответствовать вашим потребностям.

person Waylan    schedule 15.09.2017