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

Question

當我查看文檔時，大多數頁面底部都有前一章和下一章鏈接/按鈕，例如virtualenv 。 我無法使用Sphinx文檔工具找到如何為我的項目文檔完成此操作。 有人能告訴我這是如何工作的或指向一個有用的資源（雖然我已經搜索了很多）？

Answer 1

關於模板的sphinx-doc.org文檔提到了next和prev變量：

導航的下一個文檔。 此變量為false或具有兩個屬性link和title。 標題包含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>