如何在Sphinx生成的文档中添加上一章和下一章的链接？ [英] How do I add a 'previous chapter' and 'next chapter' link in documentation generated by Sphinx?

问题描述

当我查看文档时，大多数页面的底部都有上一章和下一章的链接/按钮，例如virtualenv。我找不到如何使用Sphinx文档工具为我的项目文档实现这一点。谁能告诉我这是如何工作的，或者给我指给我一个有用的资源(尽管我已经搜索了很多)？

推荐答案

关于模板的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>

这篇关于如何在Sphinx生成的文档中添加上一章和下一章的链接？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！