sphinxcontrib-taglist

sphinxcontrib-taglist è un "taglist" estensione Sfinge.
TagList
Taglist è un'estensione di sistema di documentazione Sfinge.
Installazione
Instalation attraverso pip:
Pip installare sphinxcontrib-taglist
o tramite github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py install
Successivamente, si deve aggiungere l'estensione a 'conf.py' nel progetto sfinge.
estensioni = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Configurazione
Quando si utilizza tag con questa estensione è possibile dare ad ogni tag altro colore. Potete farlo in 'conf.py' aggiungendo:
taglist_tags = {
& Nbsp; 'tag1': {'background-color': 'green'}
}
Direttive
tag:
& Nbsp; direttiva tag aggiungere un 'pezzo' di informazioni, ed è possibile il tag.
& Nbsp; è possibile utilizzarlo come:
& Nbsp; .. tag :: Alcuni dati con tag
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; oppure:
& Nbsp; .. tag :: [tag1 tag2 tag3] Alcuni dati con tag

& Nbsp; Attenzione: Secondo metodo viene utilizzato solo se il primo metodo non è.
& nbsp; Attenzione: non sono sicuro che questa sintassi, può cambiare. Se avete suggerimenti Anny per favore fatemelo sapere.
taglist:
& Nbsp; taglist è una direttiva che cattura tag e fare un elenco.
& Nbsp; In primo luogo la stampa 'Tags: ...' informazioni quali tag visualizza, e di quello che mostra l'elenco.
& Nbsp; è possibile utilizzarlo come:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Come funziona?
Il codebase è derivato da sphinxcontrib-requisiti in modo che funziona in modo simile.
Durante documento direttive tag lettura creano tag_node`s. `Taglist creare nodi taglist.
Durante risolvere nodi taglist sono cambiato in un pezzo di testo Tags: con gli elementi tag che verranno visualizzati in tale elenco. Successivo stampa tutti gli articoli con tag.
CSS
taglist.css:
& Nbsp; Contiene classe base per tag - taglist_tag

& Nbsp; Attenzione: Probabilmente sarà cambiato e messo in taglist_tags.css. (E sarà configurabile da conf.py)
Inoltre, crea il file taglist_tags.css durante la lavorazione (con css per ogni tag si è definito in conf.py; taglist_tags mappe tutte le chiavi dei tag ai tasti CSS). E scrivono per costruire directory di file statici

Requisiti :

• Python
• Sphinx