Github 使用include with Sphinx在自述文件中正确显示图像

Github 使用include with Sphinx在自述文件中正确显示图像,github,python-sphinx,Github,Python Sphinx,我想在我的readme.rst文件中包含一个图像,并使其在Github和Sphinx在ReadTheDocs上生成的文档中正确显示 文件结构如下: readme.rst # first readme docs/ index.rst readme.rst # second readme images/ my_image.png 第二个自述文件包含 .. include:: ../readme.rst 如果我将第一个自述文件中的\

我想在我的readme.rst文件中包含一个图像,并使其在Github和Sphinx在ReadTheDocs上生成的文档中正确显示

文件结构如下:

readme.rst         # first readme
docs/
    index.rst
    readme.rst     # second readme
    images/
         my_image.png
第二个自述文件包含

.. include:: ../readme.rst
如果我将第一个自述文件中的\u图像的路径指定为

.. image:: images/my_image.png
它正确地出现在sphinx生成的文档中,包括本地文档和ReadTheDocs站点。但是,它没有出现在Github的自述部分中

要让它出现在Github上,我需要将路径更改为

.. image:: docs/images/my_image.png
但它不再出现在当地的狮身人面像上,也不再出现在ReadTheDocs网站上


当然这很有道理。。。但是,是否有任何技巧/配置设置可供使用,以便在任何地方都可以正确写入和解释图像的路径(同时仍然使用Sphinx的..include指令)?

作为解决方法,我在主目录下创建了一个图像目录,并简单地复制了相关图像。由于图像更新的频率不如文档的其他部分,因此它似乎是最不容易出错的选项。