sphinxcontrib-taglist

sphinxcontrib-taglist est un "taglist" extension Sphinx.
TagList
Taglist est une extension de Sphinx système de documentation.
Installation
Installation par pip:
pip installer sphinxcontrib-taglist
ou par github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py install
Ensuite, vous devez ajouter extension au «conf.py 'dans votre projet de sphinx.
extensions = [
& Nbsp; ...,
& Nbsp; »sphinxcontrib.taglist ',
& Nbsp; ...]
Configuration
Lorsque vous utilisez des étiquettes avec cette extension, vous pouvez donner à chaque tag autre couleur. Vous pouvez le faire en "conf.py» en ajoutant:
taglist_tags = {
& Nbsp; »tag1 ': {' background-color ':« verte »}
}
Directives
tag:
& Nbsp; de directive marque Ajouter une 'pièce' de l'information, et vous pouvez l'étiqueter.
& Nbsp; Vous pouvez l'utiliser comme:
& Nbsp; .. :: tag Certaines informations étiquetées
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; ou:
& Nbsp; .. :: tag [tag1 tag2 tag3] Quelques informations balisé

& Nbsp; Attention: Deuxième méthode ne est utilisée que si la première méthode ne est pas.
& nbsp; Attention: Je ne suis pas sûr cette syntaxe, il peut changer. Si vous avez des suggestions de Anny se il vous plaît laissez-moi savoir.
taglist:
& Nbsp; taglist est une directive qui attraper balises et faire une liste.
& Nbsp; d'abord il imprime 'Tags: ...' avec les informations des balises, il affiche, et qu'il montre la liste.
& Nbsp; Vous pouvez l'utiliser comme:
& Nbsp; .. :: taglist
& Nbsp;: tags: tag1 tag3
Comment ça marche?
Le code source est dérivé de sphinxcontrib-exigences de sorte qu'il fonctionne de façon similaire.
Pendant le document de lecture d'étiquette directives créent tag_node`s. `Taglist créer nœuds taglist.
Lors de la résolution des noeuds taglist sont changé à un morceau de texte Balises: avec des étiquettes articles qui seront affichés sur cette liste. Ensuite, il imprime tous les articles étiquetés.
CSS
taglist.css:
& Nbsp; Il contient la classe de base pour la balise - taglist_tag

& Nbsp; Attention: Il sera probablement changé et mis en taglist_tags.css. (Et il sera configurable de conf.py)
En outre, il crée le fichier taglist_tags.css pendant le traitement (avec css pour chaque balise vous avez défini dans conf.py; taglist_tags cartes toutes les touches de balises à des touches css). Et écrivent pour construire répertoire pour les fichiers statiques

Exigences :

• Python
• Sphinx