首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何在Sphinx TOC中包含主页?

如何在Sphinx TOC中包含主页?
EN

Stack Overflow用户
提问于 2013-04-21 02:51:24
回答 1查看 7.3K关注 0票数 31

假设我有一个包含以下来源的Sphinx项目:

index.rst
installation.rst
templating/
    index.rst
    module.rst
    fieldtype.rst

index.rst (主页)具有以下目录树:

.. toctree::
   :titlesonly:

   installation
   templating/index

我希望我的模板包括一个侧栏,列出所有3个顶级页面(主页,安装,模板/索引)。

我尝试在主页中添加第二个隐藏的TOC树:

.. toctree::
   :hidden:

   index

.. toctree::
   :titlesonly:

   installation
   templating/index

这实际上给了我想要的结果,只是它将next变量设置为当前页面。所以我的模板中的代码如下:

Next up: <a href="{{ next.link }}">{{ next.title }}</a>

…始终从主页输出主页链接。不是很好。

我一直尝试将实际的主页链接硬编码到模板的侧边栏中:

{% set homeClass = 'current' if pagename == 'index' else '' %}
<ul class="{{ homeClass }}">
    <li class="toctree-l1 {{ homeClass }}"><a class="{{ homeClass }} reference internal" href="/index.html">Home</a></li>
</ul>
{{ toctree() }}

这也是可行的,除了我不想强制在web服务器的webroot上访问文档之外,- I希望它们也能在文件系统上工作。

我不能简单地将URL设置为“index.html”,因为当您在templating/中的文件中时,这将不起作用。

我是不是漏掉了什么明显的东西?必须有一种在不破坏next链接的情况下将主页放入目录中的方法,并且具有在本地文件系统上工作的动态路径,即使从子文件夹中也是如此。

EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/16123951

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档