如何将readthedocs网页重定向到其他网站

时间:2016-11-09 07:14:39

标签: read-the-docs

我们开始在readthedocs网站上提供我们项目的文档(比如http://abc.readthedocs.org)。出于各种原因,我们现在使用新域(http://abc.io)迁移到我们自己的Web服务器。

我们希望优雅地降低http://abc.readthedocs.org,以便我们的项目文档不会在整个互联网上被破坏。

我们想到的一种方法是从所有带有前缀(http://abc.readthedocs.org)的页面“重定向”到(http://abc.io)。

但是,我没有在readthedocs站点中看到任何重定向选项,它提供了重定向到全新域的重定向。 Readthedocs仅允许在同一域下的不同页面内重定向。

关于我如何进行的任何指示都会非常有帮助。

2 个答案:

答案 0 :(得分:1)

我将以下部分添加到index.rst

.. raw:: html

    <script type="text/javascript">
    if (String(window.location).indexOf("readthedocs") !== -1) {
        window.alert('The documentation has moved. I will redirect you to the new location.');
        window.location.replace('http://cosmo-docs.phys.ethz.ch/cosmoHammer');
    }
    </script>

答案 1 :(得分:1)

在ReadTheDocs管理页面上,&#34;精确重定向&#34;重定向的形式允许&#34;中的其他域到URL&#34;领域。但它似乎只是为每个规则重定向一页。也就是说,它需要一个&#34; Exact&#34;比赛。我希望使用(.*)$1进行some mod_rewrite魔术。但是没有建立。

另一个有效(但很笨重)的想法是使用一个使用markdown的docs文件夹创建一个临时存储库。 index.md文件可以包含刷新:

<meta http-equiv="refresh" content="0; URL=https://new.location">`

您还可以添加带有直接链接的html,以防刷新无法正常工作 conf.py文件可以是:

from recommonmark.parser import CommonMarkParser

source_parsers = {'.md': CommonMarkParser}

source_suffix = ['.md']
master_doc = 'index'

将此存储库提交给github(或其他主机),并将RTD项目的项目URL更改为此临时存储库。您可以为临时存储库创建标记。匹配您的实际存储库。然后确保ReadTheDocs构建每个版本。如果一切顺利,每个版本的主页将重定向到刷新发送的位置。

如果项目管理页面上提供的重定向允许将前缀重定向到其他域,那就太好了。