sphinxcontrib-taglist

sphinxcontrib-taglist on Sphinx "taglist" laajennus.
TagList
Taglist on laajennus Sphinx dokumentaatiojärjestelmän.
Asennus
Instalation kautta pip:
Pip asentaa sphinxcontrib-taglist
tai github:
git klooni https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py asentaa
Seuraavaksi sinun täytyy lisätä laajennus "conf.py" omalla sfinksi projekti.
laajennukset = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist",
& Nbsp; ...]
Asetukset
Käytettäessä tunnisteet tämä laajennus voit antaa kullekin tag muu väri. Voit tehdä sen "conf.py" lisäämällä:
taglist_tags = {
& Nbsp; "Tag1": {"background-color": "vihreä"}
}
Direktiivit
Tag:
& Nbsp; tag direktiivin lisätä "pala" tietoa, ja voit merkitä sen.
& Nbsp; Voit käyttää sitä, kuten:
& Nbsp; .. tag :: Jotkut merkityt tiedot
& Nbsp;: tag: Tag1 Tag2 TAG3
& Nbsp; tai:
& Nbsp; .. tag :: [Tag1 Tag2 TAG3] Jotkut merkityt tiedot

& Nbsp; Varoitus: Toinen tapa on käyttää vain, jos ensimmäinen menetelmä ei ole.
& nbsp; Varoitus: En ole varma, että tämä syntaksi, se voi muuttua. Jos sinulla on Anny ehdotuksia kerro minulle.
taglist:
& Nbsp; taglist on direktiivi, joka pyydystää tunnisteet ja tee lista.
& Nbsp; Ensinnäkin se tulostaa "Tunnisteet: ..." tietoja, joita tunnisteet se näyttää, ja kuin se näkyy luettelossa.
& Nbsp; Voit käyttää sitä, kuten:
& Nbsp; .. taglist ::
& Nbsp;: Tunnisteet: Tag1 TAG3
Kuinka se toimii?
Codebase on peräisin sphinxcontrib-vaatimukset niin se toimii samalla tavalla.
Aikana asiakirjan käsittelyssä tag direktiivit luovat tag_node`s. `Taglist luoda taglist solmuja.
Aikana ratkaisemisessa taglist solmut muuttuvat palan tekstiä Tunnisteet: tunnisteita kohteita, jotka näkyvät tässä luettelossa. Seuraavaksi se tulostaa kaikki tagged kohteita.
CSS
taglist.css:
& Nbsp; Se sisältää kantaluokka tag - taglist_tag

& Nbsp; Varoitus: Luultavasti muuttuu ja laittaa taglist_tags.css. (Ja se on määritettävissä conf.py)
Lisäksi se luo tiedoston taglist_tags.css käsittelyn aikana (CSS jokaiselle tag te määritelty conf.py; taglist_tags kartat kaikki tag avaimet css avaimet) ja kirjoittaa se rakentaa hakemiston staattisia tiedostoja.

Vaatimukset :

• Python
• sfinksi