当前位置:  开发笔记 > 编程语言 > 正文

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

如何解决《在sphinx和github中使用相同的README内容-相对链接》经验,为你挑选了0个好方法。

我正在为我的项目添加一个Read The Docs页面.现在,我想在我的Read The Docs主页上看到与我的自述文件中相同的内容.我的docs/index.rst文件看起来像:

.. include:: ../README.rst

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


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

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

这主要是有效的,除了相对链接.例如,我的README包含:

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

由于Sphinx在docs目录中构建了所有内容,因此期望INSTALL.rst在docs目录中找到它.

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

我怎样才能使Github和Read The Docs(Sphinx)正确呈现相对链接而不会有重复文件(或者最好是重复文件)?

推荐阅读
ERIK又
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有