更改Sphinx的目录模板

时间:2013-10-16 20:35:14

标签: html templates twitter-bootstrap python-sphinx restructuredtext

我正在使用Sphinx和我自己的模板来获取类似twitter bootstrap文档的文档样式:http://getbootstrap.com/2.3.2/getting-started.html

在那里你可以看到左边的导航,这是静态的,并且在你滚动的同时就停留在同一个地方。

因此,必须使用此函数呈现我已经实现的目录:

{{ toctree(maxdepth=1, collapse=False, includehidden=true) }}

这使我得到以下信息:

<ul class="current">
    <li class="toctree-l1 current"><a class="current reference internal" href="">Introduction</a></li>
    <li class="toctree-l1"><a class="reference internal" href="#installation">Installation</a></li>
    <li class="toctree-l1"><a class="reference internal" href="#roadmap">Roadmap</a></li>
</ul>

但是为了让它与bootstrap一起工作,我需要以下输出:

<ul class="nav nav-list bs-docs-sidenav">
    <li><a href="#introduction"><i class="icon-chevron-right"></i> Introduction</a></li>
    <li><a href="#installation"><i class="icon-chevron-right"></i> Installation</a></li>
    <li><a href="#roadmap"><i class="icon-chevron-right"></i> Roadmap</a></li>
</ul>

所以我的问题是:我怎样才能做到这一点?我可以调整toctree()函数的模板文件吗?

1 个答案:

答案 0 :(得分:0)

我有类似的问题,我使用混合的自定义角色和jQuery来根据我的角色位置调整此问题。 jQuery将改变你需要的所有东西。