python - 如何在 Sphinx 生成的文档中添加 'previous chapter' 和 'next chapter' 链接？

Question

当我查看文档时，大多数页面的底部都有上一章和下一章的链接/按钮，例如 virtualenv .我无法找到如何使用 Sphinx 为我的项目文档完成此操作文档工具。有人可以告诉我这是如何工作的或为我指出有用的资源(尽管我已经搜索了很多)吗？

Answer 1

sphinx-doc.org关于模板的文档提到了 next 和 prev 变量:

The next document for the navigation. This variable is either false or has two attributes link and title. The title contains HTML markup. For example, to generate a link to the next page, you can use this snippet:

{% if next %}
    <a href="{{ next.link|e }}">{{ next.title }}</a>
{% endif %}

查看更多信息:http://www.sphinx-doc.org/en/master/templating.html#next

您可以在您的 Sphinx 模板中的任何位置使用它们，并相应地使用 CSS 设置样式。

---

一个完整的例子可能是:

<ul class="footer_nav">
    {%- if prev %}
      <li class="prev">
        Previous topic: <a href="{{ prev.link|e }}">{{ prev.title }}</a>
      </li>
    {%- endif %}

    {%- if next %}
      <li class="next">
        Next topic: <a href="{{ next.link|e }}">{{ next.title }}</a>
      </li>
    {%- endif %}
</ul>