sphinxcontrib-taglist

sphinxcontrib-taglist е Сфинкс "taglist" разширение.
<Силен> TagList
Taglist е разширение на Сфинкса система документация.
<Силен> Монтаж
Монтаж чрез семка:
PIP инсталирате sphinxcontrib-taglist
или чрез GitHub:
Git клонинг https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-taglist
питон setup.py инсталиране
На следващо място, трябва да добавите разширение "conf.py" във вашата сфинкс проект.
разширенията = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist",
& Nbsp; ...]
<Силен> Configuration
При използване на тагове с това разширение може да искате да даде всеки таг друг цвят. Можете да направите това в "conf.py" чрез добавяне на:
taglist_tags = {
& Nbsp; "TAG1": {"фон-цвят": "зелена"}
}
Директиви
тагове:
& Nbsp; Директива етикет на "парче" на информацията, и можете да го маркирате.
& Nbsp; Можете да го използвате като:
& Nbsp; .. маркер :: Някои Tagged информация
& Nbsp; Етикет: TAG1 tag2 tag3
& Nbsp; или:
& Nbsp; .. маркер :: [TAG1 tag2 tag3] Някои Tagged информация
<Силен>
& Nbsp; Внимание: Втори метод се използва само, ако първият метод не е.
<Силен> & Nbsp; Внимание: Аз не съм сигурен, че този синтаксис, то може да се промени. Ако имате Anny предложения, моля да ме уведомите.
taglist:
& Nbsp; taglist е директива, която хвана тагове и направи списък.
& Nbsp; Първо го отпечатва "Tags: ..." с информация кои маркери да го показва, и от него показва списъка.
& Nbsp; Можете да го използвате като:
& Nbsp; .. taglist ::
& Nbsp;: тагове: TAG1 tag3
Как работи?
В програмния код се получава от sphinxcontrib-изисквания, така че тя работи в подобен начин.
По време на документ директиви четене тагове създават tag_node`s. `Taglist създаде taglist възли.
По време на решаването taglist възли се променя на парче текстови Tags: с етикети, книги, които ще бъдат показани на този списък. Следваща разпечатва всички маркирани елементи.
CSS
taglist.css:
& Nbsp; Той съдържа базов клас за маркер - taglist_tag
<Силен>
& Nbsp; Внимание: Тя вероятно ще бъде променена и се слага в taglist_tags.css. (И това ще бъде конфигурируеми от conf.py)
Освен това, той създава файл taglist_tags.css на по време на преработка (с CSS за всеки таг ви е определено в conf.py; taglist_tags карта на всички ключове маркер към CSS ключове). И ще го напиша за изграждане на указателя да статични файлове

<силни> Изисквания :

• Python
• Сфинкс