sphinxcontrib-taglist

sphinxcontrib-taglist es una extensión "taglist" Esfinge.
TagList
Taglist es una extensión al sistema de documentación Esfinge.
Instalación
Instalación a través de la pipa:
PIP instalar sphinxcontrib-taglist
oa través de GitHub:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py install
A continuación, hay que añadir la extensión a 'conf.py' en su proyecto esfinge.
extensiones = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist ',
& Nbsp; ...]
Configuración
Cuando el uso de etiquetas con esta extensión es posible que desee dar a cada etiqueta de otro color. Usted puede hacer eso en 'conf.py' añadiendo:
taglist_tags = {
& Nbsp; "etiqueta 1 ': {' background-color ':' verde '}
}
Directivas
etiqueta:
& Nbsp; directiva tag agregar una "pieza" de la información, y se puede etiquetarlo.
& Nbsp; Usted puede usarlo como:
& Nbsp; .. etiqueta :: Parte de la información etiquetada
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; o:
& Nbsp; .. :: etiqueta [tag1 tag2 tag3] Parte de la información etiquetada

& Nbsp; Advertencia: En segundo método se utiliza sólo si primero método no es.
& nbsp; Advertencia: No estoy seguro de esta sintaxis, puede cambiar. Si tiene alguna sugerencia anny por favor hágamelo saber.
taglist:
& Nbsp; taglist es una directiva que coger las etiquetas y hacer una lista.
& Nbsp; En primer lugar se imprime 'Tags: ...' con la información que etiqueta que muestra, y de lo que muestra la lista.
& Nbsp; Usted puede usarlo como:
& Nbsp; .. taglist ::
& Nbsp;: Etiquetas: etiqueta 3 código1
Cómo funciona?
El código base se deriva de sphinxcontrib-requisitos por lo que funciona en forma similar.
Durante documento directivas etiqueta lectura crean tag_node`s. `Taglist crear nodos taglist.
Durante la resolución de nodos taglist se cambian a un pedazo de texto Etiquetas: con las etiquetas elementos que se mostrarán en la lista. Siguiente imprime todos los artículos etiquetados.
CSS
taglist.css:
& Nbsp; Contiene clase base para la etiqueta - taglist_tag

& Nbsp; Advertencia: Probablemente será cambiado y puesto en taglist_tags.css. (Y será configurable desde conf.py)
Además, crea el taglist_tags.css archivo durante el proceso (con css para cada etiqueta que definió en conf.py; taglist_tags mapas todas las teclas de etiquetas de teclas css). Y escriben para construir directorio para archivos estáticos

Requisitos :

• Python
• esfinge