2017-09-13 193 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會在那裏的服務器上建立網站,這意味着你被困在他們的環境中,這可能會或可能不適合你的需求。

相關問題