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

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

я использую 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, кроме плагинов по умолчанию, присутствующих в сборочной среде.

1 ответ

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

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

Другие вопросы по тегам