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

Question

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

Answer 1

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

用於導航的下一個文檔。這個變量是false或者 有兩個屬性鏈接和標題。標題包含HTML標記。對於 例如，要生成一個鏈接到下一個頁面，你可以使用這個 片段：

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

多見於：http://sphinx-doc.org/templating.html#next

您可以在獅身人面像的模板和風格，在任何地方使用它們相應的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>