And*_*dré 6 github python-sphinx
我想在readme.rst文件中包含一个图像,并在Github和Sphinx在ReadTheDocs上生成的文档中正确显示
文件结构如下:
readme.rst # first readme
docs/
index.rst
readme.rst # second readme
images/
my_image.png
Run Code Online (Sandbox Code Playgroud)
第二个自述文件包含
.. include:: ../readme.rst
Run Code Online (Sandbox Code Playgroud)
如果我在第一个自述文件中指定my_image的路径为
.. image:: images/my_image.png
Run Code Online (Sandbox Code Playgroud)
它在本地和ReadTheDocs站点上由sphinx生成的文档中正确显示.但是,它没有出现在Github的自述文件部分中.
要让它出现在Github上,我需要改变路径
.. image:: docs/images/my_image.png
Run Code Online (Sandbox Code Playgroud)
但它不再出现在当地的狮身人面像上,也不会出现在ReadTheDocs网站上.
当然,这是非常合情合理的.不过,有没有可以使用的,这样的图像的路径可以写成并解释正确everwhere(同时仍使用狮身人面像..include指令)的任何伎俩/配置设置?
| 归档时间: |
|
| 查看次数: |
332 次 |
| 最近记录: |