2017-09-13 9 views
0

docsには、ビルドが行われるvirtualenvにあらかじめインストールされているプラ​​グインがほんの少数しかないことがあります。カスタムプラグインを使用してドキュメントサービスを読むにはどうしたらいいですか?サードパーティのpythonプラグイン extensionsの使い方は?

私は次の拡張子を追加した mkdocs.yml設定ファイルに、少しドキュメントを構築するために mkdocsを使用しています

:に展開する際に、正常に動作しているプレビューがmkdocs serveを添えてローカル環境では

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 

を(接続されたgithubリポジオを介して)ドキュメントを読むと、pymdownxプラグインが見つからないためビルドに失敗しましたが、ビルドenvにあるデフォルトのプラグインとは別にRTDによって自動的に取得されたと思いました。

答えて

0

AFAIK、ドキュメントを読む(RTD)はサードパーティの拡張機能の使用をサポートしていません。実際、RTDはMkDocsバージョン0.14のみをサポートしています。しかし、MkDocsには複数のバグが修正され、さまざまな機能が追加されている(現在0.16まで)ため、複数のリリースが追加されています。

RTDは、MkDocsのホスト間で一意です。他のすべてのホストでは、サイトをローカルに構築してから、ホストにプッシュする必要があります。これにより、ビルドに適した環境を確保することができます。しかし、RTDはサーバー上にサイトを構築します。つまり、環境に悩まされていることを意味します。

関連する問題