sphinxcontrib-taglist

sphinxcontrib-taglist este un Sfinx "taglist" extindere.
TagList
Taglist este o extensie a sistemului de documentare Sfinxul.
Instalare
Instalatie prin PIP:
Pip instala sphinxcontrib-taglist
sau prin github:
git clona https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py instalare
Mai departe, trebuie să adăugați extensia la "conf.py" în proiectul dumneavoastră sfinx.
extensii = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist",
& Nbsp; ...]
Configurare
Când utilizați etichete cu această extensie poate doriți dau fiecare etichetă altă culoare. Puteți face acest lucru în "conf.py", adăugând:
taglist_tags = {
& Nbsp; "tag1": {"background-color": "verde"}
}
Directivă
tag:
& Nbsp; de directivă etichetă adăuga o "bucată" de informație, și îl puteți eticheta.
& Nbsp; se poate folosi ca:
& Nbsp; .. etichetă :: Unele informații taguri
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; sau:
& Nbsp; .. etichetă :: [tag1 tag2 tag3] Unele informații taguri

& Nbsp; Avertisment: A doua metodă este folosită doar dacă primul metodă nu este.
& nbsp; Avertisment: Nu sunt sigur că acest lucru sintaxă, se poate schimba. Dacă aveți sugestii anny vă rog să-mi spuneți.
taglist:
& Nbsp; taglist este o directivă care prind tag-uri și de a face o listă.
& Nbsp; În primul rând se imprimă "Tag-uri: ..." cu informații pe care tags se afișează, și decât arată lista.
& Nbsp; se poate folosi ca:
& Nbsp; .. taglist ::
& Nbsp;: Tag-uri: tag1 tag3
Cum funcționează?
Codebase este derivat din sphinxcontrib-cerințe, astfel că funcționează în mod similar.
În timpul document de directivele tag lectură a crea tag_node`s. `Taglist crea noduri taglist.
În timpul rezolvarea noduri taglist sunt schimbate la o bucată de text de Tag-uri: cu tag-uri elemente care vor fi afișate pe această listă. Mai departe se imprimă toate articolele etichetate.
CSS
taglist.css:
& Nbsp; Acesta conține clasa de baza pentru etichetă - taglist_tag

& Nbsp; Avertisment: Este, probabil, va fi modificat și pus în taglist_tags.css. (Și va fi configurabil din conf.py)
În plus, se creează taglist_tags.css fișier în timpul de prelucrare (cu CSS pentru fiecare tag-ați definit în conf.py; taglist_tags harti toate cheile etichetă la chei CSS). Și scrie-l pentru a construi director la fișiere statice

Cerințe :

• Python
• Sfinxul