sphinxcontrib-taglist

sphinxcontrib-taglist является "taglist" расширение Сфинкс.
TagList
Taglist является расширением Сфинкс системы документации.
Установка
Монтажные через пип:
пункт установить sphinxcontrib-taglist
или через GitHub:
Git клон https://github.com/spinus/sphinxcontrib-taglist
CD-taglist sphinxcontrib
питон setup.py установить
Далее, вы должны добавить расширение на '' conf.py в сфинкса проекта.
Расширения = [
& NBSP; ...,
& NBSP; 'sphinxcontrib.taglist ",
& NBSP; ...]
Конфигурация
При использовании тегов с этим расширением вы можете дать каждому тег другой цвет. Вы можете сделать это в "conf.py", добавив:
taglist_tags = {
& NBSP; 'tag1 ": {" цвет фона ":" зеленые "}
}
Директивы
тег:
& NBSP; директива тег добавить '' кусок информации, и вы можете пометить его.
& NBSP; Вы можете использовать его как:
& NBSP; .. бирка :: Некоторые тегами информация
& NBSP; Метка: tag1 tag2 tag3
& NBSP; или:
& NBSP; .. бирка :: [tag1 tag2 tag3] Некоторые тегами информация

& NBSP; Внимание: Второй способ используется, только если первый способ не является.
& NBSP; Внимание: Я не уверен, что этот синтаксис, это может измениться. Если у вас есть предложения, пожалуйста, Anny, дайте мне знать.
taglist:
& NBSP; taglist является директива, которая поймать теги и сделать список.
& NBSP; Во-первых, печатает "Теги: ... информацию, которая помечает он отображает, и чем это показывает список.
& NBSP; Вы можете использовать его как:
& NBSP; .. taglist ::
& NBSP;: Теги: tag1 tag3
Как это работает?
Кодовой базы происходит от sphinxcontrib-требований, так что работает аналогичным образом.
Во документа директивы чтение тегов создать tag_node`s. `taglist создать taglist узлов.
Во время решения taglist узлы заменяются на кусок текста тегами: с тегами элементов, которые будут отображаться в этом списке. Следующая печатает все элементы с тегом.
CSS
taglist.css:
& NBSP; Он содержит базовый класс для тега - taglist_tag

& NBSP; Внимание: Это, вероятно, будет изменено и поставить в taglist_tags.css. (И это будет настраивается от conf.py)
Кроме того, он создает файл taglist_tags.css во время обработки (с помощью CSS для каждого тега, определенного в conf.py; taglist_tags отображает все ключи тегов клавишам CSS). И написать это, чтобы построить каталог на статических файлов

Требования

• Python
• Сфинкс