2010-09-21 6 views
8

Bu terminoloji bölümündeki terimleri her kullanışımda, tanıma işaret eden bir bağlantı oluşturulduğu şekilde kullandığım terimlerin tanımları ile bir "terminoloji" bölümü oluşturmak istiyorum. ŞuSphinx'te nasıl büyük bir yük olmadan linkable bir "terminoloji" bölümü oluşturabilirim?

, ayağa düşünebiliriz en iyisi:

''' This is a usage of the word |flavor|.''' 

çok hantal olması yukarıdaki sözdizimi bulmak: Sonra

.. |flavor| replace:: `:ref:flavor` 

.. _flavor: 

flavor 
------ 
blah blah blah 

sonra diğer metinde yapmam gerekiyor. Ben bu sözdizimi olarak oluşturmak auto komut dosyası veya m4 başka bir katman kullanabilirsiniz biliyorum ama .. daha iyi bir yol var çok farklı değil

cevap

20

umuyorum, ancak kullanabilirsiniz:

.. Sözlük ::

Bu yönerge, terimler ve tanımlar içeren bir reST tanımlama listesi içermelidir. Tanımlar daha sonra 'vadeli' rolüyle belirtilebilir.

: Burada: sözlüğü bir terim için

referans. Sözlük, terimler ve tanımlar ile bir tanım listesi içeren sözlük yönergesi kullanılarak oluşturulur. Terim işareti ile aynı dosyada olması gerekmez; örneğin, Python belgelerinin glossary.rst dosyasında bir global sözlüğü vardır.

Sözlükte açıklanmayan bir terim kullanırsanız, oluşturma sırasında bir uyarı alırsınız.

[official sphinx documentation]

+0

yapıştırılan ben sfenks docs ararken "terminolojisi" için farklı bir kelime bulmak için sözlüğe danıştı should'a sanırım. Teşekkürler eolo999. –

İlgili konular