2013-06-19 14 views
8

Sphinx (sphinx-1.2b1-py2.7) ile çalışıyorum. Bir kenar çubuğunda görünmek için bir TOC istiyorum. İkili gibi görünüyor: Ben sadece kenar çubuğunda bir TOC hem de metnin gövdesinde madde işaretli bir liste alabilirim veya hiçbir şey elde edemiyorum (kenar çubuğunda hiçbir TOC yok ve madde işareti yok).Sphinx toctree, vücutta madde işaretli liste ile kenar çubuğunda bir TOC veya hiçbir şey göstermiyor

.. toctree:: 
    :hidden: 

    Topic1 
    Topic2 

Sonuç: Böyle toctree yönergesini kullandığınızda

kenar çubuğunda hiçbir TOC, hiçbir vücutta konuların listesini madde işaretli. kenar çubuğuna VE vücutta konuların işaretli liste TOK:

.. toctree:: 

    Topic1 
    Topic2 

Sonuç:

böyle toctree yönergesini kullandığınızda.

Sadece TOK'u kenar çubuğunda istiyorum. Diğer komutlar (maxdepth, includehidden) çalışmıyor. Bunu gördüm, ama işe yaramaz. Conf.py iyi görünüyor, ancak birkaç gün arandığında cevap aramanıza gerek yok. Teşekkürler.

+0

olduğu gibi

.. toctree:: :hidden: 

toctree() çağrısına argüman includehidden=True eklemektir gibi kullanıldığı zaman Ben şunu düşünürdüm: .. ile:: noindex: seçeneği hile yapar, ama hayır, hiçbir şey. –

cevap

4

Bu konuda da sıkıntı çektim; Cevabı here buldum. TOK, örn., Layout.html adlı bir dosya içinde toctree() aramasındaki bir çağrı yoluyla gösterilir. Ben bir tema kullanıyorum yana

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

, layout.html dizin _themes içindeki tema dizin içinde geçerli: Özellikle, <div class="sidebar"> ikamet aşağıdakine benzer bir kod parçalarını aracılığıyla kenar çubuğunda gösterilir ; Aksi halde layout.html, _templates dizininde olabilir. TOK görüntülemek için ihtiyaç duyulan şey Sfenks'in yeni sürümlerinde

, :hidden:

{% block sidebartoc %} 
<h3>{{ _('Table Of Contents') }}</h3> 
{{ toctree(includehidden=True) }} 
{% endblock %} 
İlgili konular