sphinxcontrib-taglist

sphinxcontrib-taglist er en Sphinx "taglist" udvidelse.
TagList
Taglist er en udvidelse til Sphinx dokumentationssystem.
Installation
Instalation gennem pip:
pip installere sphinxcontrib-taglist
eller gennem GitHub:
git klon https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py installere
Dernæst skal du tilføje udvidelse til 'conf.py' i dit sphinx projekt.
extensions = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist«,
& Nbsp; ...]
Konfiguration
Ved brug af tags med denne udvidelse kan du give hver tag anden farve. Du kan gøre det i »conf.py« ved at tilføje:
taglist_tags = {
& Nbsp; "TAG1": {"background-color ':" grøn "}
}
Direktiver
tag:
& Nbsp; tag direktiv tilføje et "stykke" af information, og du kan mærke det.
& Nbsp; Du kan bruge det som:
& Nbsp; .. tag :: Nogle mærkede information
& Nbsp;: tag: TAG1 tag2 tag3
& Nbsp; eller:
& Nbsp; .. tag :: [TAG1 tag2 tag3] Nogle mærkede information

& Nbsp; Advarsel: Second metode bruges kun, hvis første metode er ikke.
& nbsp; Advarsel: Jeg er ikke sikker på denne syntaks, kan det ændre sig. Hvis du har Anny forslag så lad mig det vide.
taglist:
& Nbsp; taglist er et direktiv, som fanger tags og gøre en liste.
& Nbsp; For det første udskriver »Tags: ..." med oplysninger, som tags den viser, og end den viser listen.
& Nbsp; Du kan bruge det som:
& Nbsp; .. taglist ::
& Nbsp;: tags: TAG1 tag3
Sådan virker det?
Den kodebase stammer fra sphinxcontrib-krav, så det virker på lignende måde.
Under dokument læsning tag direktiver skaber tag_node`s. `Taglist skabe taglist noder.
Under løse taglist knudepunkter er ændret til et stykke tekst Tags: med tags emner, som vil blive vist på denne liste. Næste den udskriver alle mærkede varer.
CSS
taglist.css:
& Nbsp; Den indeholder base klasse for tag - taglist_tag

& Nbsp; Advarsel: Det vil sandsynligvis blive ændret og sat i taglist_tags.css. (Og det vil være konfigurerbar fra conf.py)
Derudover skaber det filen taglist_tags.css under forarbejdningen (med css for hvert mærke du har defineret i conf.py; taglist_tags kortlægger alle tag nøglerne til css nøgler). Og skrive det til at bygge mappe til statiske filer

Krav :

• Python
• Sphinx