sphinxcontrib-taglist

sphinxcontrib-taglist is een Sphinx "taglist" extensie.
taglist
Taglist is een uitbreiding van Sphinx documentatiesysteem.
installatie
Instalatie door pip:
pip sphinxcontrib-taglist installeren
of via GitHub:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py installeren
Vervolgens moet je extensie toe te voegen aan 'conf.py' in je sfinx project.
extensions = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Configuratie
Bij het gebruik van tags met deze extensie wilt u misschien geven elkaar tag andere kleur. Je kunt dat in 'conf.py' doen door het toevoegen van:
taglist_tags = {
& Nbsp; 'tag1': {'background-color': 'groene'}
}
Richtlijnen
tag:
& Nbsp; tag richtlijn voeg een 'stukje' van informatie, en je kunt het taggen.
& Nbsp; U kunt het gebruiken als:
& Nbsp; .. tag :: Enkele getagde informatie
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; of:
& Nbsp; .. tag :: [tag1 tag2 tag3] Sommige getagde informatie

& Nbsp; Waarschuwing: Tweede methode wordt alleen gebruikt als eerste methode is het niet.
& nbsp; Waarschuwing: Ik ben er niet zeker van dat dit syntax, kan het veranderen. Als u anny suggesties laat het me weten.
taglist:
& Nbsp; taglist is een richtlijn die tags te vangen en doe een lijst.
& Nbsp; In de eerste plaats wordt afgedrukt 'Tags: ...' met informatie over welke tags het toont, en dan het toont de lijst.
& Nbsp; U kunt het gebruiken als:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Hoe het werkt?
De codebase is afgeleid van sphinxcontrib-eisen, zodat het werkt op dezelfde manier.
Tijdens het lezen van documenten tag richtlijnen creëren tag_node`s. `Taglist creëren taglist knooppunten.
Tijdens het oplossen van taglist knopen worden veranderd in een stuk tekst Tags: met markeringen items die op de lijst wordt weergegeven. Vervolgens drukt alle gelabelde items.
CSS
taglist.css:
& Nbsp; Het bevat basisklasse voor tag - taglist_tag

& Nbsp; Waarschuwing: Het zal waarschijnlijk worden veranderd en zet in taglist_tags.css. (En het zal configureerbaar van conf.py zijn)
Daarnaast creëert het bestand taglist_tags.css tijdens de verwerking (met css voor elke tag die u hebt gedefinieerd in conf.py; taglist_tags kaarten alle tag sleutels tot css toetsen). En schrijf het naar directory bouwen om statische bestanden

Eisen

• Python
• Sphinx