sphinxcontrib-taglist

sphinxcontrib-taglist egy Sphinx "taglist" kiterjesztést.
TagList
Taglist egy kiterjesztése a Szfinx dokumentációs rendszer.
Telepítés
Felszerelés keresztül pip:
pip telepíteni sphinxcontrib-taglist
vagy GitHub:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py telepíteni
Ezután meg kell adni kiterjesztése "conf.py" a szfinx projekt.
extensions = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist",
& Nbsp; ...]
Configuration
Amikor a címkéket ezt a kiterjesztést érdemes, hogy minden tag más színű. Megteheti, hogy a "conf.py" hozzáadásával:
taglist_tags = {
& Nbsp; "tag1": {background-color: "zöld"}
}
Irányelvek
tag:
& Nbsp; tag irányelv adjunk hozzá egy "darab" információ, és akkor el címkével.
& Nbsp; Használhatja, mint:
& Nbsp; .. tag :: Néhány címkézett információk
& Nbsp;: tag: tag1 tag2 TAG3
& Nbsp; vagy:
& Nbsp; .. tag :: [tag1 tag2 TAG3] Néhány címkézett információk

& Nbsp; Figyelmeztetés: Második módszer csak ha az első módszer nem.
& nbsp; Figyelmeztetés: Nem vagyok biztos benne ez a forma, ez megváltozhat. Ha Anny javaslatokat kérem tudassa velem.
taglist:
& Nbsp; taglist egy irányelvet, amely elkapni címkék és csinál egy listát.
& Nbsp; Először is kiír "Címkék: ..." tájékoztatást, hogy mely címkéket megjeleníti, és mint listáját jeleníti meg.
& Nbsp; Használhatja, mint:
& Nbsp; .. taglist ::
& Nbsp;: címkék: tag1 TAG3
Hogyan működik?
A codebase származik sphinxcontrib-követelmények így működik hasonló módon.
Során a leírások olvasása tag irányelvek létre tag_node`s. `Taglist létre taglist csomópontok.
Alatt megoldása taglist csomópontok változott a szöveg egy részét Címkék: címkékkel tételek jelennek meg ezen a listán. Next nyomtat az összes kijelölt elem.
CSS
taglist.css:
& Nbsp; tartalmazza osztályok számára tag - taglist_tag

& Nbsp; Figyelmeztetés: Valószínűleg meg fog változni, és tegye a taglist_tags.css. (És ez lesz konfigurálható conf.py)
Továbbá, ez létrehozza a fájlt taglist_tags.css feldolgozás során (a css minden tag határozott meg conf.py; taglist_tags térképek minden tag gombok css billentyűk) és írd meg, hogy építsen könyvtár statikus fájlokat.

követelmények :

• Python
• Sphinx