gpt4 book ai didi

python-sphinx - Sphinx toctree 要么在侧边栏中显示一个目录,在正文中显示项目符号列表,要么什么都不显示

转载 作者:行者123 更新时间:2023-12-03 09:25:50 26 4
gpt4 key购买 nike

我正在使用 Sphinx (sphinx-1.2b1-py2.7)。我希望 TOC 出现在侧边栏中。它似乎是二元的:我只能在侧边栏中获得目录,在正文中获得项目符号列表,或者我什么也得不到(侧边栏中没有目录,也没有项目符号列表)。

当我像这样使用 toctree 指令时:

.. toctree::  
:hidden:

Topic1
Topic2

结果:侧边栏中没有目录,正文中没有项目符号列表。

当我像这样使用 toctree 指令时:
.. toctree::  

Topic1
Topic2

结果:侧栏中的目录和正文中的项目符号列表。

我只想要侧边栏中的目录。其他命令(maxdepth、includehidden)不起作用。我已经看到它完成了,但无法让它工作。 conf.py 看起来不错,但在寻找答案几天后没有运气。
谢谢。

最佳答案

我也遇到了麻烦;我找到了答案here .

TOC 通过调用 toctree() 显示。例如,一个名为 layout.html 的文件。特别是,它通过类似于以下的代码片段显示在侧栏中,该代码位于 <div class="sidebar"> 中。 :

{% block sidebartoc %}
<h3>{{ _('Table Of Contents') }}</h3>
{{ toctree() }}
{% endblock %}

由于我使用的是主题,因此 layout.html 位于目录 _themes 内的主题目录中;否则 layout.html 可能在目录 _templates 中。

在较新版本的 Sphinx 中,当 :hidden: 时显示 TOC 需要什么用于
.. toctree::  
:hidden:

是添加参数 includehidden=True调用 toctree() ,如
{% block sidebartoc %}
<h3>{{ _('Table Of Contents') }}</h3>
{{ toctree(includehidden=True) }}
{% endblock %}

关于python-sphinx - Sphinx toctree 要么在侧边栏中显示一个目录,在正文中显示项目符号列表,要么什么都不显示,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17194400/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com