SphinxContrib-Paverutils. integração esfinge / pavimentadora
Baixe Agora

SphinxContrib-Paverutils. Classificação e resumo

SphinxContrib-Paverutils. Tag

Biblioteca Python. Pitão Esfinge calceteiro integração de pavimentadora Integração Esfinge

SphinxContrib-Paverutils. Descrição

Integração esfinge / pavimentadora SphInxContrib-Paverutils é um módulo Python que fornece uma integração alternativa de esfinge e pavimentadora. Suporta a chamada Sphinx de dentro da pavimentadora usando várias configurações e não supor que você só deseja construir o HTML Output.basic usageto Use este módulo, importe-o em seu arquivo pavement.py como do SphinxContrib Import Paperututils, então definir pacotes de opção para "HTML Saída "e / ou" PDF "usando as opções descritas na ajuda da tarefa.Por exemplo: Import paverimport paver.misctasksfrom paver.Path Import PathFrom Paver.Easy Import * Import paver.setuputilspaver.setuputils.install_distutils_tasks () Tente: da Importação SphinxContrib Paverutilsexcept: Avisos de importação Avisos.Warn ('sphinxcontrib.paverutils não foi encontrado, você não será capaz de produzir documentação' opções (configuração = bando (nome = 'myproject', versão = '1.0', # ... Mais opções Aqui ...), # padrões para sphinxcontrib.paverutils sphinx = bando (docroot = '.', sourcedir = 'docsource', construtor = 'html',), # uma configuração para construir HTML para o pacote HTML = bando (builddir = 'docs', confdir = 'sphinx / pkg',), # Outra configuração w com diferentes modelos # para construir HTML para fazer upload para o site do site = bando (builddir = 'web', confdir = 'sphinx / web',), # também queremos um arquivo PDF para o site, # então as instruções estão incluídas em o diretório de configuração da Web #. pdf = bando (builddir = 'web', construtor = 'látex', confdir = 'sphinx / web',),) Parâmetros de configuraçãoDocroot a raiz em que a Esfinge estará funcionando. Padrão: diretório DOCSBuilddir sob o Docroot onde os arquivos resultantes são colocados. Padrão: BuildSourCedir Diretório sob o Docroot para os arquivos de origem Padrão: (string vazia) Douthees A localização do Docthees em cache Padrão: $ BuildDir / Doctreesconfdir A localização do Sphinx conf.py padrão: $ sourcediroutdir a localização dos arquivos de saída gerados padrão : $ builddir / $ builderbuilder O nome do construtor Sphinx para usar o padrão: HTMLTEMplate_args Dicionário de valores a serem passados como pares de valor de nome para o padrão HTML Builder: {} Uso avançado Você também pode desenvolver suas próprias tarefas chamando Run_Sphinx () diretamente : @ Task @ Necessidades () @ cmdops () DEF Blog (Opções): "" "Gere a versão do blog do HTML para o módulo atual." "" # gerar html de sphinx paverutils.run_sphinx (opções,' blog ') blog_file = caminho ( Opções.blog.outdir) / Opções.blog.out_file dry ("escrever blog postar corpo para% s"% blog_file, gen_blog_post, outdir = options.blog.outdir, input_base = options.blog .in_file, blog_base = options.blog.out_file,) se 'editor' em os.environ: sh ('$ editor% s'% blog_file) regresso: · Pitão O que há de novo nesta versão: · Atualizado para incluir função run_script ().

SphinxContrib-Paverutils. Software Relacionado