sphinxcontrib-taglist

sphinxcontrib-taglist är en Sphinx "taglist" förlängning.
TagList
Taglist är ett tillägg till Sphinx dokumentationssystem.
Installation
Installation via pip:
PiP installera sphinxcontrib-taglist
eller genom github:
git clone https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-taglist
Python setup.py installera
Därefter måste du lägga till förlängning till "conf.py" i ditt sphinx projekt.
extensions = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist ",
& Nbsp; ...]
Konfiguration
Vid användning av taggar med denna förlängning kan du ge varje tagg annan färg. Du kan göra det i "conf.py" genom att lägga:
taglist_tags = {
& Nbsp; 'tag1': {"bakgrundsfärg": "grön"}
}
Direktiven
tag:
& Nbsp; tag direktivet lägga till en "bit" av information, och du kan tagga det.
& Nbsp; Du kan använda den som:
& Nbsp; .. tag :: Viss taggad informationen
& Nbsp;: tag: tag1 tag2 TAG3
& Nbsp; eller:
& Nbsp; .. tag :: [tag1 tag2 TAG3] Vissa taggad informationen

& Nbsp; Varning: Andra metoden används endast om första metoden inte är.
& nbsp; Varning: Jag är inte säker på att den här syntaxen kan det förändras. Om du har Anny förslag vänligen låt mig veta.
taglist:
& Nbsp; taglist är ett direktiv som fångar taggar och göra en lista.
& Nbsp; För det första skriver "Tags: ..." med information som taggar den visar, och än det visar listan.
& Nbsp; Du kan använda den som:
& Nbsp; .. taglist ::
& Nbsp;: taggar: tag1 TAG3
Hur det fungerar?
Kodbasen kommer från sphinxcontrib-krav så det fungerar på liknande sätt.
Under dokument direktiv läsning tagg skapar tag_node`s. 'Taglist skapa taglist noder.
Under lösa taglist noder ändras till ett stycke text Taggar: med tags objekt som kommer att visas på den listan. Nästa skriver ut alla taggade objekt.
CSS
taglist.css:
& Nbsp; Den innehåller basklass för taggen - taglist_tag

& Nbsp; Varning: Det kommer förmodligen att ändras och sätta i taglist_tags.css. (Och det kommer att vara konfigurerbar från conf.py)
Dessutom skapar det filen taglist_tags.css under bearbetning (med css för varje tagg som du definierat i conf.py; taglist_tags kartor alla märkta nycklar till css nycklar). Och skriver den för att bygga katalog till statiska filer

Krav :

• Python
• Sphinx