2017-09-13 194 views
0

我已阅读docs只有少数插件已预安装在构建发生的virtualenv中。我如何使用自定义插件读取文档服务呢?如何使用第三方python插件 extensions?

我使用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自动从构建环境中的默认插件中提取。

回答

0

AFAIK,阅读文档(RTD)不支持使用第三方扩展。实际上,RTD仅支持MkDocs 0.14版本。然而,MkDocs已经有了多个额外的版本(目前为0.16),每个版本都修复了多个bug并增加了各种功能。

RTD在MkDocs的主机中是唯一的。对于所有其他主机,您需要在推送到主机之前在本地构建站点。这可以让你确保你有一个适合你的构建的环境。但是,RTD会在那里的服务器上建立网站,这意味着你被困在他们的环境中,这可能会或可能不适合你的需求。

相关问题