sphinxcontrib-taglist

sphinxcontrib-taglist je sfinga "taglist" prodloužení.
TagList
Taglist je rozšíření Sphinx systému dokumentace.
Instalace
Instalace přes PIP:
Pip nainstalovat sphinxcontrib-taglist
nebo prostřednictvím GitHub:
git clone https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-taglist
python setup.py nainstalovat
Dále budete muset přidat příponu "conf.py" v Sphinx projektu.
rozšíření = [
& Nbsp; ...
& Nbsp; "sphinxcontrib.taglist"
& Nbsp; ...]
Configuration
Při použití značek s tímto rozšířením můžete chtít dát každou značku jinou barvu. Můžete to udělat v "conf.py", tím, že přidá:
taglist_tags = {
& Nbsp; "tag1": {"background-color": "green"}
}
Směrnice
tag:
& Nbsp; směrnice tag přidat "kousek" informace, a můžete označit ji.
& Nbsp; Můžete ji použít jako:
& Nbsp; .. tag :: Některé označené informace
& Nbsp;: tag: tag1 Tag2 tag3
& Nbsp; nebo:
& Nbsp; .. tag :: [tag1 Tag2 tag3] Některé označené informace

& Nbsp; Upozornění: Druhá metoda se používá pouze v případě, první metoda není.
& nbsp; Upozornění: Nejsem si jist, že to syntaxe, může se změnit. Máte-li návrhy Anny, prosím dejte mi vědět.
taglist:
& Nbsp; taglist je směrnice, které uloví tagy a udělat seznam.
& Nbsp; Za prvé vytiskne "Tagy: ..." informace, které značky se zobrazí, a než se zobrazí seznam.
& Nbsp; Můžete ji použít jako:
& Nbsp; .. taglist ::
& Nbsp;: Tagy: tag1 tag3
Jak to funguje?
Codebase je odvozen od sphinxcontrib-požadavků funguje podobným způsobem.
V dokumentu, směrnice čtení tagů vytvořit tag_node`s. `Taglist vytvořit taglist uzly.
Při řešení taglist uzlů se mění na kus textu Tagy: s tagy předměty, které se budou zobrazovat na tomto seznamu. Dále se vytiskne všechny označené položky.
CSS
taglist.css:
& Nbsp; obsahuje základní třídy pro značku - taglist_tag

& Nbsp; Upozornění: to asi bude měnit a dát do taglist_tags.css. (A to bude konfigurovatelné z conf.py)
Kromě toho, že vytvoří soubor taglist_tags.css při zpracování (s CSS pro každou značku, kterou jste definovali v conf.py; taglist_tags mapuje všechny klíče značek CSS klíčů), a zapsat jej postavit adresář statické soubory

Požadavky na :

• Python
• Sphinx