sphinxcontrib-taglist

sphinxcontrib-taglist is 'n Sphinx "taglist" uitbreiding.
TagList
Taglist is 'n uitbreiding van Sphinx dokumentasie stelsel.
Installasie
Instalation deur pit:
PIP installeer sphinxcontrib-taglist
of deur GitHub:
git kloon https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py installeer
Volgende, jy het die uitbreiding te voeg tot 'conf.py' in jou sfinks projek.
uitbreidings = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Konfigurasie
Wanneer die gebruik van etikette met hierdie uitbreiding kan jy gee vir elke tag ander kleur. Jy kan dit doen in 'conf.py' deur die toevoeging van:
taglist_tags = {
& Nbsp; 'tag1': {'agtergrond-kleur: groen}
}
Riglyne
tag:
& Nbsp; tag richtlijn voeg 'n 'stukkie' van inligting, en jy kan dit merk.
& Nbsp; Jy kan dit gebruik soos:
& Nbsp; .. tag :: Sommige Tagged inligting
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; of:
& Nbsp; .. tag :: [tag1 tag2 tag3] Sommige Tagged inligting

& Nbsp; Waarskuwing: Tweede metode word slegs gebruik as die eerste metode is nie.
& nbsp; Waarskuwing: Ek is nie seker dat hierdie sintaksis, kan dit verander. As jy Anny voorstelle laat weet my asseblief.
taglist:
& Nbsp; taglist is 'n richtlijn wat vang tags en doen 'n lys.
& Nbsp; Eerstens druk 'Tags: ...' met inligting wat etikette dit gee, en as dit wys die lys.
& Nbsp; Jy kan dit gebruik soos:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Hoe dit werk?
Die kodebasis is afgelei van sphinxcontrib-vereistes, sodat dit werk in 'n soortgelyke manier.
Gedurende dokument lees tag voorskrifte skep tag_node`s. `Taglist skep taglist nodes.
Gedurende die oplossing taglist nodes verander word na 'n stuk van die teks Tags: met tags items wat op die lys vertoon word. Volgende is dit druk alle tagged items.
CSS
taglist.css:
& Nbsp; Dit bevat basis klas vir etiket - taglist_tag

& Nbsp; Waarskuwing: Dit sal waarskynlik verander word en sit in taglist_tags.css. (En dit sal instel van conf.py wees)
Verder, dit skep die lêer taglist_tags.css tydens die verwerking (met css vir elke tag wat jy omskryf in conf.py; taglist_tags kaarte al tag sleutels te css sleutels). En skryf dit gids te bou statiese lêers

Vereistes :

• Python
• Sphinx