在 Python Sphinx 图像指令中使用环境变量

Question

我有一个带有 Sphinx 文档的 Python 项目，为了保持代码库较小，我想包含在文档中的一些图像和其他文件位于单独的存储库中。

对于 Sphinx 文档构建，我确实设置了一个 shell 环境变量以指向另一个存储库。我尝试从image directive 使用它，如下所示：

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

但这不起作用。

现在，我在docs/conf.py 中放了一些代码，将我需要的文件复制到docs 源代码树中，然后它就可以工作了。但这感觉像是一种 hack，必须有适当/更好的方法来做到这一点？

Answer 1

我找到了解决我的问题的以下解决方案。

访问Change variable in sphinx conf.py as part of build command

基本上，我们可以在 Jupyter 中定义可以在 ma​​ke.bat 文件中初始化的 env 变量，方法是设置以下 cmets：

Jupyter 笔记本：

try:
    status_flag = %env status_flag
    print('Status_flag defined as ' + status_flag + '!')
    
except:
    status_flag = 'MP4'
    print('Status_flag defined as ' + status_flag + '!')

make.bat:

SET status_flag=HTML
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%