sphinxcontrib-taglist

sphinxcontrib-taglist bir Sfenks "taglist" uzantısıdır.
TagList
Taglist Sfenks dokümantasyon sistemi bir uzantısıdır.
Kurulum
Pip ile Kurulum:
sphinxcontrib-taglist yüklemek pip
veya github üzerinden:
Git klon https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-taglist
piton setup.py install
Daha sonra, sfenks projede 'conf.py' uzantısını eklemek zorunda.
uzantıları = [
& Nbsp; ...
& Nbsp; 'sphinxcontrib.taglist'
& Nbsp; ...]
Yapılandırma
Bu uzantıya sahip etiketleri kullanırken her etiketiyle diğer renk vermek isteyebilirsiniz. Sen ekleyerek 'conf.py' de yapabilirsiniz:
taglist_tags = {
& Nbsp; 'tag1': {background-color ':' Yeşil '}
}
Direktifler
etiket:
& Nbsp; etiket yönergesi bilgi 'parça' ekleyin, ve bunu etiketleyebilirsiniz.
& Nbsp; bunu gibi kullanabilirsiniz:
& Nbsp; .. etiketi :: Bazı etiketli bilgiler
& Nbsp;: tag: tag1 tag2 TAg3
& Nbsp; veya:
& Nbsp; .. etiketi :: [tag1 tag2 TAg3] Bazı etiketli bilgiler

& Nbsp; Uyarı: İlk yöntem değilse İkinci yöntem, yalnızca kullanılır.
& nbsp; Uyarı: Bu sözdizimi, bu değişebilir emin değilim. Eğer anny önerileriniz varsa lütfen bana bildirin.
taglist:
& Nbsp; taglist etiketleri yakalamak ve bir yapılacaklar listesi bir direktif olduğunu.
& Nbsp; Öncelikle 'Etiketler: ...' yazdırır o görüntüler, ve listesini gösterir daha etiketleri bilgi.
& Nbsp; bunu gibi kullanabilirsiniz:
& Nbsp; .. taglist ::
& Nbsp;: etiketler: tag1 TAg3
Nasıl çalışır?
benzer bir şekilde çalışır, böylece kod temeli sphinxcontrib-gereklerinden türetilmiştir.
Belgenin sırasında okuma etiketi direktifleri tag_node`s oluşturun. `Taglist taglist düğümleri oluşturmak.
Taglist düğümleri çözmek sırasında metin Etiketler bir parça değiştirilir: o listede görüntülenir etiketleri öğeleri ile. Sonraki tüm etiketli öğeleri yazdırır.
CSS
taglist.css:
& Nbsp; Bu etiket için temel sınıf içerir - taglist_tag

& Nbsp; Uyarı: Muhtemelen değişti ve taglist_tags.css konacaktır. (Ve conf.py gelen yapılandırılabilir olacak)
Ayrıca, işlem sırasında dosya taglist_tags.css oluşturur (Eğer conf.py tanımlanan her etiket için css ile, taglist_tags css tuşları tüm etiket anahtarlarını eşler). Ve statik dosyaları dizin oluşturmak için yazmak