2014-06-09 17 views
22

Yerel bir içerik tablosu Sphinx doc'a nasıl eklenir? Yerel bir içerik tablosu Sphinx doc'a nasıl eklenir?

Ben
.. toc:: 

çalıştı Ama bu herhangi bir etkisi görünmüyor: hiçbir şey belgeye eklenir.

Temel olarak, her sayfanın belirli bir konumuna yerleştirilmek üzere geçerli sayfadaki bölümlere bağlantılara ihtiyacım var.

Bu mümkün mü?

cevap

24

Aradığınızı tam olarak bulamadığınızdan% 100 emin değilim, ancak .. contents:: yönergesi yardımcı olabilir. Varsayılan olarak, yönergeyi koyduğunuz her yerde size tüm sayfanın başlığını verir. :local: belirtildiğinde, yönergeleri koyduğunuz başlıklar için yerel bir TOC oluşturur (alt bölümler için kullanışlı). Burada

Diğer ayrıntılar: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

+3

'.. içindekiler ::: Yerel:' sihirli meyve suyu olduğunu. ': Local:' bayrakını atlarken, İçindekiler, belge başlığına bir bağlantı ile gereksiz yere hazırlanır. Dahası, tüm diğer başlıklar, belge başlığının alt başlıklarıdır ve dolayısıyla, aksi halde olması gerekenden daha fazla bir seviyede daha derin bir şekilde girintilidir. Kısacası, ': local:' çoğu kullanım durumları için zorunludur. (_I gerçekten diliyorum: local: 'varsayılan, açıkçası idi) –