sphinxcontrib-taglist

sphinxcontrib-taglist jest Sfinks "taglist" rozszerzenie.
taglist
Taglist jest rozszerzeniem systemu dokumentacji Sphinx.
instalacji
Instalacja przez pip:
pip install sphinxcontrib-taglist
lub poprzez github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py install
Następnie trzeba dodać rozszerzenie "conf.py" w projekcie sfinks.
Rozszerzenia = [
& Nbsp; ...
& Nbsp; "sphinxcontrib.taglist",
& Nbsp; ...]
Konfiguracja
Podczas korzystania tagi z tym rozszerzeniem może chcesz dać każdy tag inny kolor. Możesz to zrobić w "conf.py", dodając:
taglist_tags = {
& Nbsp; "tag1": {"background-color": "zielone"}
}
Dyrektywy
tag:
& Nbsp; dyrektywa tag dodać "kawałek" informacji, i można go oznaczyć.
& Nbsp; Można go używać jak:
& Nbsp; .. :: tag informacji oznaczonych niektórych
& Nbsp;: tag: tag1 tag2 TAG3
& Nbsp; lub:
& Nbsp; .. tag :: [tag1 tag2 TAG3] Niektóre znakowany informacje

& Nbsp; Uwaga: Druga metoda jest stosowana tylko wtedy, gdy pierwsza metoda nie jest.
& nbsp; Uwaga: , nie jestem pewien, że ta składnia, to może się zmienić. Jeśli masz pomysły Anny proszę dać mi znać.
taglist:
& Nbsp; taglist jest dyrektywa, która złapać tagi i zrobić listę.
& Nbsp; Po pierwsze drukuje "Tagi: ..." informacji, które Tagi wyświetla i nie pokazuje listę.
& Nbsp; Można go używać jak:
& Nbsp; .. taglist ::
& Nbsp;: tagi: tag1 TAG3
Jak to działa?
Baza kodu pochodzi od sphinxcontrib-wymagania, tak to działa w podobny sposób.
Podczas czytania dokumentu dyrektyw stworzyć tag_node`s tag. `Taglist stworzyć taglist węzłów.
Podczas rozwiązywania taglist węzły są zmieniane do kawałka tekstu Tagi: z elementów tagi, które będą wyświetlane na tej liście. Następny drukuje wszystkie oznaczone elementy.
CSS
taglist.css:
& Nbsp; Zawiera klasy podstawowej dla tagu - taglist_tag

& Nbsp; Uwaga: To prawdopodobnie zostanie zmieniony i umieścić w taglist_tags.css. (I to będzie konfigurowalny z conf.py)
Dodatkowo tworzy się podczas przetwarzania plików taglist_tags.css (z css dla każdej zmiennej zdefiniowanej w conf.py; taglist_tags odwzorowuje wszystkie klucze do klawiszy tag css). I napisać go budować katalog do plików statycznych

Wymagania :

• Python
• Sfinks