2013-06-19 1 views
8

私はSphinx(sphinx-1.2b1-py2.7)で作業しています。私はTOCをサイドバーに表示したい。それはバイナリのようです:私は、サイドバーの目次とテキストの本文に箇条書きのリストの両方を取得することができます、または私は何も得られません(サイドバーには箇条書きと箇条書きのリストなし)。Sphinx toctreeは、本文に箇条書きのリストを含むサイドバーにTOCを表示するか、まったく表示しません。

私はこのようなtoctreeディレクティブを使用します。

.. toctree:: 
    :hidden: 

    Topic1 
    Topic2 

結果:サイドバーではありませんTOC、体内で話題の無箇条書き。

私はこのようなtoctreeディレクティブを使用します。

.. toctree:: 

    Topic1 
    Topic2 

結果:サイドバーのTOCと身体のトピックの箇条書き。

サイドバーに目次が必要です。他のコマンド(maxdepth、includehidden)は動作しません。私はそれが完了したことを見てきましたが、それを働かせることはできません。 conf.pyはうまく見えますが、回答を検索して数日後には不運です。おかげさまで

+0

のように、toctree()に呼び出しに引数includehidden=Trueを追加することです私は ':noindex:'オプションを使って '..toctree ::'がトリックをすると思っていましたが、何もしません。 –

答えて

4

私もこれに問題がありました。答えはhereです。

TOCは、内部にtoctree()というコールを介して表示されます(たとえば、layout.htmlというファイル)。特に、それは<div class="sidebar">に存在する次のようなコードのスニペットを介してサイドバーに示されている:私はテーマを使用しておりますので

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

、layout.htmlディレクトリ_themes内のテーマディレクトリ内にあります;それ以外の場合は、layout.htmlが_templatesディレクトリ内にある可能性があります。 :hidden:

.. toctree:: 
    :hidden: 

にとして使用する場合にTOCを表示するために必要なものスフィンクスの新しいバージョンでは、

{% block sidebartoc %} 
<h3>{{ _('Table Of Contents') }}</h3> 
{{ toctree(includehidden=True) }} 
{% endblock %} 
関連する問題