python - 在sphinx和github中使用相同的自述内容-相对链接

我正在为我的项目添加“阅读文档”页面。目前，我希望Read the Docs主页上的内容与自述文件中的内容相同。我的docs/index.rst文件如下所示:

.. include:: ../README.rst

.. toctree::
   :maxdepth: 2
   :caption: Contents:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

除相对链接外，这通常有效。例如，我的自述文件包含:

See `INSTALL.rst`_ for advanced and detailed instructions.

由于Sphinx在docs目录中构建了所有内容，因此希望在docs目录中找到INSTALL.rst。

由于Github从根目录渲染文件，因此它希望在根目录中找到INSTALL.rst。

如何使Github和Read The Docs(Sphinx)都能正确呈现相对链接而没有重复文件(最好是重复)？

最佳答案

尝试使用符号链接(symbolic link)。

在sphinx目录中:

INSTALL.rst -> ../INSTALL.rst

关于python - 在sphinx和github中使用相同的自述内容-相对链接，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/42603509/