Python Sphinxイメージディレクティブで環境変数を使用

Question

私はSphinxドキュメントのPythonプロジェクトを持っており、コードリポジトリを小さく保つために、ドキュメントに含めるイメージやファイルのいくつかは別のリポジトリにあります。

Sphinx docsビルドでは、他のリポジトリを指すようにシェル環境変数を設定しています。私はこのようなimage directiveからそれを使用してみました：

.. image:: $OTHER_REPO/docs_images/image.png 

が、それは動作しません。

今のところ、私はdocsソースツリーに必要なファイルをコピーして、それが動作するようなコードをdocs/conf.pyに入れました。しかし、これはハックのように感じる、これを行う適切な/より良い方法が必要ですか？

Answer 1

conf.pyでは、rst_epilogという変数を設定できます。 replacement directiveを使用すると、実行できる可能性があります。 conf.pyで

：

rst_epilog = """ 
.. |other_repo| """ + os.environ['OTHER_REPO'] + """ 
""" 

実際の文書で：私はそれをテストしていませんが、出発点であるかもしれない

.. image:: |other_repo|/docs_images/image.png 

。