如何在Sphinx生成的文档中添加“上一章”和“下一章”链接？

Question

当我查看文档时，大多数页面底部都有前一章和下一章链接/按钮，例如virtualenv。我无法使用Sphinx文档工具了解如何为我的项目文档完成此操作。有人可以告诉我这是如何工作的或指向一个有用的资源（虽然我已经搜索了很多）？

Answer 1

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

  

导航的下一个文档。这个变量是假的或   有两个属性链接和标题。标题包含HTML标记。对于   例如，要生成指向下一页的链接，可以使用此方法   片段：

{% 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>