sphinxcontrib-taglist

sphinxcontrib-Tagliste ist eine Sphinx "Tagliste" Erweiterung.
TagList
Taglist ist eine Erweiterung von Sphinx Dokumentationssystem.
Installation
Installation durch pip:
pip sphinxcontrib-taglist installieren
oder über Github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py install
Als nächstes müssen Sie die Erweiterung 'conf.py "in Ihrem Sphinx-Projekt hinzufügen.
Erweiterungen = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist ',
& Nbsp; ...]
Konfiguration
Bei der Verwendung von Schlüsselerweiterung können Sie geben jedem Tag andere Farbe. Sie können, dass in 'conf.py' zu tun, indem:
taglist_tags = {
& Nbsp; "Tag1": {"background-color": "grüne"}
}
Richtlinien
tag:
& Nbsp; tag Richtlinie fügen Sie ein "Stück" von Informationen, und Sie können es zu markieren.
& Nbsp; Sie können es wie:
& Nbsp; .. tag :: Einige Fotos mit Namensinformationen
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; oder:
& Nbsp; .. tag :: [tag1 tag2 tag3] Einige Fotos mit Namensinformationen

& Nbsp; Warnung: Zweite Methode wird nur verwendet, wenn die erste Methode nicht.
& nbsp; Warnung: Ich bin mir nicht sicher, dass diese Syntax kann es ändern. Wenn Sie anny Anregungen haben lass es mich wissen.
taglist:
& Nbsp; taglist ist eine Richtlinie, die Tags zu fangen und machen Sie eine Liste.
& Nbsp; Zunächst druckt 'Stichworte: ... "mit Informationen, die er zeigt, und als es zeigt die Liste-Tags.
& Nbsp; Sie können es wie:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Wie funktioniert es?
Die Codebasis von sphinxcontrib-Anforderungen abgeleitet, es funktioniert in ähnlicher Weise.
Während der Beleglesung tag Richtlinien erstellen tag_node`s. `Taglist erstellen taglist Knoten.
Während die Lösung taglist Knoten mit einem Stück Text Stichworte verändert: mit Umbauten Einzelteile, die auf dieser Liste angezeigt werden. Next druckt alle markierten Einträge.
CSS
taglist.css:
& Nbsp; Sie enthält Basisklasse für tag - taglist_tag

& Nbsp; Warnung: Es wird wahrscheinlich geändert und in taglist_tags.css gestellt werden. (Und es wird konfigurierbar conf.py sein)
Außerdem erstellt es die Datei taglist_tags.css bei der Verarbeitung (mit CSS für jeden Tag, das Sie in conf.py definiert; taglist_tags bildet alle Tag Tasten css Tasten). Und schreiben Sie es in das Verzeichnis auf statische Dateien zu bauen

Anforderungen :

• Python
• Sphinx