Tracsphinx. Classificação e resumo
- Nome do editor:
- Florent PIGOUT
Tracsphinx. Tag
Tracsphinx. Descrição
Plugin Esfinge para Trac 0.11 Primeiro rascunho para esfinge como fácil de usar plugin. O Tracsphinx implementa tarefas básicas para gerenciar a documentação da Sphinx no Trac.1. Plugin InstallDownload As fontes de plug-in, descompactam o arquivo e digite o comando Easy_Install na pasta Plugin: $ Easy_Install Setup.py InstallRestart O (s) Projeto (s) Trac. Como administrador, podemos agora ativar o plugin.Por padrão A pasta de origem da documentação é './docs/source' do repositório do projeto. Mas na maioria dos casos, vamos substituir esse caminho na seção do arquivo 'trac.ini' arquivo: Source_Dir = / Esta pasta de origem é usada pelo projeto para construir a documentação Sphinx usando o Construtor Web de Esfinge. Se a documentação não puder ser gerada a partir do Trac, podemos especificar o caminho de documentação gerada com a seguinte opção: doc_dir = / Também podemos definir o título Navbar com a seguinte opção: Navbar_Title = My Documentation2. Documentação UpdatesImple Params no URL do projeto para atualizar a documentação da pasta de origem do projeto para a pasta do Projeto Trac './sphinx-docs'. Basta digitar o seguinte URL para atualização: http: // /? Ação = Refreshin Alguns casos A documentação não pode ser gerada como no caso seguinte: Automodula não pode importar parte do projeto quando usamos o automobilístico, autoclass .. Diretivas Alguns projetos não podem importar os requisitos ou config. Em seguida, a Sphinx não gerará a documentação do projeto e retornará o seguinte erro: List fora dos projetos de intervalo, como o aplicativo Turbogears. Atualmente, estamos trabalhando nesta questão e esperamos que propõe uma solução em breve. Documentação NavigationIn A barra lateral direita do Doc Esfinge no Trac encontraremos as três funções a seguir: * Tabela de ContentMenu do conteúdo da página exibida atual. * Relativa linksinclude o link de projeto de índice e módulo e o (s) link (s) anterior / seguinte. * Searchsimple Sphinx como a função de pesquisa. Nenhum javascript aqui realizamos a pesquisa no lado do servidor.4. Visão geral do URL API O plugin gerencia os seguintes URLs e parâmetros. Por padrão, a página de indexação da documentação do projeto será exibida. * / / Sphinx Padrão Page * / / sphinx? Ação = ViewItem = Ação = Ver ação para exibir uma página específica do item de documentação = Page_Name Nome da página Exibir Search_words = Palavras de A pesquisa atual (destacada na página) * / / sphinx? Ação = indexItem = GenInIndex ACTION = Índice Exibir o item Índice do Projeto Documentação = GenInIndex Exibe o Índice de Documentação do Projeto * / / Sphinx? Ação = ModulesItem = ModIndex Ação = Índice Exibir o item Índice de Módulos do Projeto = GenInIndex Exibe os módulos do projeto Index5. Próxima versão de plug-in Updatesthis implementa funcionalidades básicas Sphinx.Por favor, não hesite em enviar e-mails ou patches se tiver necessidades adicionais ou se o plugin não gerenciar sua documentação esfinge, a maneira como queremos. Requisitos: · Pitão
Tracsphinx. Software Relacionado
