ReadTheDocs robots.txt 和 sitemap.xml

Question

ReadTheDocs 为项目自动生成 robots.txt 和 sitemap.xml。每次我部署项目的新次要版本（例如4.1.10）时，我都会隐藏以前的次要版本（例如4.1.9）。 ReadTheDocs 将所有版本的条目添加到sitemap.xml，但隐藏版本也添加到robots.txt。结果是向 Google Search Console 提交站点地图，此时会导致“提交的 URL 被 robots.txt 阻止”错误，因为之前的站点地图条目现在被新生成的 robots.txt 阻止。

ReadTheDocs 为每个版本生成一个站点地图 URL，因此我们为 4.1.9 提供了这样的条目，例如：

<url>
   <loc>https://pyngrok.readthedocs.io/en/4.1.9/</loc>
   <lastmod>2020-08-12T18:57:47.140663+00:00</lastmod>
   <changefreq>monthly</changefreq>
   <priority>0.7</priority>
</url>

当4.1.10被释放并且之前的小版本被隐藏时，新生成的robots.txt得到：

Disallow: /en/4.1.9/ # Hidden version

我相信这个 Disallow 是导致 Google 抓取工具抛出错误的原因。

实际上，我在sitemap.xml 中想要的只是latest、develop 和stable，我不太在意要抓取每个版本。但我能够配置的所有as I understand it from ReadTheDocs docs 是静态robots.txt。

我想要的是发布我自己的静态sitemap.xml，而不是使用自动生成的。有什么办法可以做到这一点？

Answer 1

在尝试了一些想法之后，这是我提出的其他解决方案。由于这个问题经常被问到并且经常作为 GitHub 上的 ReadTheDocs 的错误被打开（事实并非如此，它似乎没有得到很好的支持和/或记录），我将在这里分享我的解决方法以供其他人查找。

如上文和文档中所述，虽然 ReadTheDocs 允许您覆盖自动生成的 robots.txt 并发布您自己的，但您不能使用 sitemap.xml。不清楚为什么。无论如何，您可以简单地发布一个不同 sitemap.xml，我将我的命名为sitemap-index.xml，然后告诉您的robots.txt 指向您的自定义站点地图。

对于我的自定义sitemap-index.xml，我只放置我关心的页面而不是生成的版本（因为stable 和latest 确实是我希望搜索引擎抓取的页面，而不是版本化页面）：

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
        xmlns:xhtml="http://www.w3.org/1999/xhtml">
    <url>
        <loc>https://pyngrok.readthedocs.io/en/stable/</loc>
        <changefreq>weekly</changefreq>
        <priority>1</priority>
    </url>
    <url>
        <loc>https://pyngrok.readthedocs.io/en/latest/</loc>
        <changefreq>daily</changefreq>
        <priority>0.9</priority>
    </url>
    <url>
        <loc>https://pyngrok.readthedocs.io/en/develop/</loc>
        <changefreq>monthly</changefreq>
        <priority>0.1</priority>
    </url>
</urlset>

我创建了自己的 robots.txt，它告诉 Google 除了我的主要分支之外不要抓取任何东西并且指向我的自定义 sitemap-index.xml。

User-agent: *

Disallow: /

Allow: /en/stable

Allow: /en/latest

Allow: /en/develop

Sitemap: https://pyngrok.readthedocs.io/en/latest/sitemap-index.xml

我将这两个文件放在/docs/_html 下，并添加到我的Sphinx conf.py 文件（位于/docs）中：

html_extra_path = ["_html"]

repo 中也显示了这个，for reference。

ReadTheDocs 重建必要的分支后，将/en/latest/sitemap-index.xml 改为Google Search Console，而不是默认的，要求谷歌重新处理你的robots.txt，不仅会解决抓取错误，谷歌还会正确索引一个网站隐藏以前的次要版本。