sphinxcontrib-taglist

sphinxcontrib-taglist er en Sphinx "taglist" forlengelse.
TagList
Taglist er en utvidelse til Sphinx dokumentasjonssystem.
Installasjon
Installasjon gjennom pip:
PIP installere sphinxcontrib-taglist
eller gjennom github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py installere
Deretter må du legge til forlengelse til 'conf.py "i sfinks prosjektet.
utvidelser = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Konfigurasjon
Når du bruker tags med denne utvidelsen kan være lurt å gi hver tag annen farge. Du kan gjøre det i 'conf.py' ved å legge til:
taglist_tags = {
& Nbsp; 'tag1': {'background-color': 'grønn'}
}
Direktiver
tag:
& Nbsp; tag direktiv legge en 'stykke "av informasjon, og du kan merke det.
& Nbsp; Du kan bruke den som:
& Nbsp; .. tag :: Noen kodet informasjon
& Nbsp;: tag: tag1 Tag2 tag3
& Nbsp; eller:
& Nbsp; .. tag :: [tag1 Tag2 tag3] Noen kodet informasjon

& Nbsp; Advarsel: Andre metoden brukes bare hvis første metoden er ikke.
& nbsp; Advarsel: Jeg er ikke sikker på at dette syntaks, kan det endre seg. Hvis du har Anny forslag vennligst gi meg beskjed.
taglist:
& Nbsp; taglist er et direktiv som fange koder og gjøre en liste.
& Nbsp; For det første skriver 'Tags: ...' med informasjon som koder det viser, og enn det viser listen.
& Nbsp; Du kan bruke den som:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Hvordan det fungerer?
Kodebasen er avledet fra sphinxcontrib-krav slik det fungerer på lignende måte.
Under dokument skape lese tag direktiver tag_node`s. `Taglist skape taglist noder.
Under løse taglist noder er endret til et stykke tekst Tags: med tags elementer som skal vises på den listen. Neste det skrives alle merkede elementer.
CSS
taglist.css:
& Nbsp; Den inneholder base klasse for tag - taglist_tag

& Nbsp; Advarsel: Det vil sannsynligvis bli endret og satt i taglist_tags.css. (Og det vil være konfigurerbar fra conf.py)
I tillegg skaper det filen taglist_tags.css under behandlingen (med css for hver kode du definert i conf.py; taglist_tags maps alle tag nøkler til css nøkler). Og skrive det å bygge katalogen til statiske filer

Krav :

• Python
• Sphinx