如何使用 Sphinx 和 ReadTheDocs 主题添加“Fork me on Github”功能区？

Question

许多开源项目在文档页面的右上角使用“Fork me on Github”横幅。

仅举一个例子，让我们以 Python请求为例：

Github 博客上有一篇关于提供图像代码的横幅的文章：GitHub Ribbons

但没有解释如何在使用 Sphinx 生成的每个页面中添加链接，然后上传到 ReadTheDocs。

你能帮忙自动生成这个吗？我预计会有一个选项，conf.py但我没有找到。我的 Sphinx 配置是默认配置。

Answer 1

最简单的方法是使用替代主题，例如alabaster它带有预配置选项github_banner（请参阅Joran 的答案）。

对于其他类似sphinx-rtd-theme不提供此类设置的主题，解决方案是依赖Sphinx 模板。

必须创建docs/_templates/layout.html包含以下内容的文件：

{% extends '!layout.html' %}
{% block document %}
{{super()}}
    <a href="https://github.com/you">
        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
    </a>
{% endblock %}