sphinxcontrib-taglist

sphinxcontrib-taglist є "taglist" розширення Сфінкс.
TagList
Taglist є розширення Сфінкса системи документації.
Установка
Монтажні через піп:
пункт встановити sphinxcontrib-taglist
або через GitHub:
Git клон https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-taglist
Python 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
• Сфінкс