sphinxcontrib-taglist

sphinxcontrib-taglist Sphinx "taglist" uzantısıdır.
TagList
Taglist Sphinx sənədləşmə sistemində bir uzantısıdır.
Quraşdırma
Tırtıl ilə instalation:
sphinxcontrib-taglist bərpa tırtıl
və ya github vasitəsilə:
git klon https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python bərpa setup.py
Next, sizin sfinks layihə "conf.py" üçün uzadılması əlavə etmək üçün var.
uzantıları = [
& Nbsp; ...
& Nbsp; 'sphinxcontrib.taglist,
& Nbsp; ...]
Konfiqurasiya
Bu uzadılması ilə tags istifadə edərkən hər bir tag digər rəng vermək istəyirəm bilər. Siz əlavə "conf.py 'da bunu edə bilər:
taglist_tags = {
& Nbsp; 'tag1: {"background-color:' Yaşıl '}
}
Direktiv
tag:
& Nbsp; tag direktiv məlumat "parça" əlavə, siz tag bilər.
& Nbsp; Siz kimi istifadə edə bilərsiniz:
& Nbsp; .. tag :: Bəzi tagged məlumat
& Nbsp; tag: tag1 tag2 tag3
& Nbsp; və ya:
& Nbsp; .. tag :: [tag1 tag2 tag3] Bəzi tagged məlumat

& Nbsp; Warning: birinci metodu deyilsə İkinci üsul istifadə olunur.
& nbsp; Warning: Bu syntax, bu dəyişə bilər əmin deyiləm. Siz anny təklifiniz varsa xahiş edirik Mənə bildirin.
taglist:
& Nbsp; taglist tags tutmaq və bir siyahısı bir direktiv edir.
& Nbsp; Əvvəlcə bu Tags: ... "çap onu göstərir ki, bu siyahısını göstərir daha tags məlumat.
& Nbsp; Siz kimi istifadə edə bilərsiniz:
& Nbsp; .. taglist ::
& Nbsp; tags: tag1 tag3
Bu necə işləyir?
oxşar şəkildə çalışır, belə ki, codebase sphinxcontrib-tələblərindən irəli gəlir.
Sənədin zamanı oxu tag direktivləri tag_node`s yaradır. `Taglist taglist qovşaqlarının yaradır.
Taglist qovşaqlarının həll zamanı mətn Tags bir parça dəyişir: ki, siyahıda göstərilir tags maddələri ilə. Next bütün tagged maddələr görüntüler.
CSS
taglist.css:
& Nbsp; Bu tag üçün baza sinif var - taglist_tag

& Nbsp; Warning: Bu yəqin ki, dəyişdirilə və taglist_tags.css qoyulacaq. (Və conf.py yapılandırılabilir olacaq)
Bundan əlavə, emal zamanı fayl taglist_tags.css yaradır (Əgər conf.py müəyyən edilmiş hər tag üçün CSS ilə; taglist_tags css düymələri bütün tag düymələri xəritələr). Və statik faylları kataloq yaratmaq üçün yazmaq