[英]How to use third-party python plugins\extensions?
我在文档上已经读到,只有很少的插件预先安装在进行构建的virtualenv中。 然后,如何使用带有自定义插件的read docs服务?
我正在使用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与构建环境中存在的默认插件不同。
AFAIK,阅读文档(RTD)不支持使用第三方扩展。 实际上,RTD仅支持MkDocs版本0.14。 但是,自从MkDocs(目前最高为0.16)以来,它又发布了多个附加版本,每个版本都修复了多个错误并添加了各种功能。
RTD在MkDocs的主机之间是唯一的。 对于所有其他主机,需要先在本地构建站点,然后再推送到主机。 这样可以确保您拥有适合自己构建的环境。 但是,RTD在该服务器上构建站点,这意味着您受其环境的束缚,这可能会或可能无法满足您的需求。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.