sphinxcontrib-taglist

sphinxcontrib-taglist é uma extensão do Sphinx "taglist".
TagList
Taglist é uma extensão do sistema de documentação Sphinx.
Instalação
Instalação através pip:
pip instalar sphinxcontrib-taglist
ou através github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py instalar
Em seguida, você tem que adicionar a extensão 'conf.py' em seu projeto esfinge.
extensões = [
& Nbsp; ...,
& Nbsp; "sphinxcontrib.taglist ',
& Nbsp; ...]
Configuração
Quando o uso de tags com esta extensão você pode querer dar a cada tag outra cor. Você pode fazer isso em 'conf.py ", acrescentando:
taglist_tags = {
& Nbsp; "tag1 ': {' background-color ':' green '}
}
Directivas
tag:
& Nbsp; directiva tag adicionar um 'pedaço' de informações, e você pode marcá-lo.
& Nbsp; Você pode usá-lo como:
& Nbsp; .. tag :: Algumas informações marcado
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; ou:
& Nbsp; .. :: tag [tag1 tag2 tag3] Algumas informações marcado

& Nbsp; Atenção: segundo método é usado somente se primeiro método não é.
& nbsp; Atenção: Não estou certo de esta sintaxe, pode mudar. Se você tiver sugestões de anny por favor me avise.
taglist:
& Nbsp; taglist é uma directiva que pegar tags e fazer uma lista.
& Nbsp; Em primeiro lugar ele imprime 'Tags: ...' com informações que marca apresenta, e que ela mostra a lista.
& Nbsp; Você pode usá-lo como:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Como funciona?
O código-fonte é derivada de sphinxcontrib-requisitos para que ele funciona de maneira similar.
Durante documento directivas tag leitura criar tag_node`s. `Taglist criar nós taglist.
Durante a resolução de nós taglist são alterados para um pedaço de texto Tags: com etiquetas itens que serão exibidos nessa lista. Em seguida, imprime todos os itens marcados.
CSS
taglist.css:
& Nbsp; Ele contém classe base para tag - taglist_tag

& Nbsp; Atenção: Ele provavelmente será alterada e colocar em taglist_tags.css. (E será configurável de conf.py)
Além disso, ele cria o arquivo taglist_tags.css durante o processamento (com css para cada tag que você definiu na conf.py; taglist_tags mapeia todas as chaves de tag para chaves CSS). E escrevê-lo para construir o diretório para arquivos estáticos

Requisitos :

• Python
• Sphinx