我想在readme.rst文件中包含一个图像,并在Github和Sphinx在ReadTheDocs上生成的文档中正确显示
文件结构如下:
readme.rst # first readme
docs/
index.rst
readme.rst # second readme
images/
my_image.png
第二个自述文件包含
.. include:: ../readme.rst
如果我在第一个自述文件中指定my_image的路径为
.. image:: images/my_image.png
它在本地和ReadTheDocs网站上由sphinx生成的文档中正确显示。但是,它没有出现在Github的自述文件部分中。
要让它出现在Github上,我需要改变路径
.. image:: docs/images/my_image.png
但它不再出现在当地的狮身人面像上,也不会出现在ReadTheDocs网站上。
当然这很有道理......但是,是否有任何技巧/配置设置可以使用,以便可以在任何地方正确地编写和解释图像的路径(同时仍然使用Sphinx的..include指令)?