SphinxContrib-Paverutils Integración de la esfinge / pavimentadora
Descargar ahora

SphinxContrib-Paverutils Clasificación y resumen

SphinxContrib-Paverutils Etiquetas

Biblioteca de Python Pitón Esfinge pavimentar integración de adoquines Integración de Esfinge

SphinxContrib-Paverutils Descripción

Integración de la esfinge / pavimentadora SphinxContrib-Paverutils es un módulo Python que proporciona una integración alternativa de la esfinge y la pavimentadora. Admite la esfinge de llamadas desde dentro de la pavimentadora utilizando múltiples configuraciones, y no asume que solo desea crear una salida HTML.BASIC USAGETO Use este módulo, impórtelo en su archivo PAVEMENT.PY, a partir de los paverutiles de importación SPHINXCONTRIB, y luego defina los paquetes de opciones para "HTML SALIDA "Y / O" PDF "usando las opciones que se describen en la ayuda de la tarea. Por ejemplo: Importar paverimport paver.misctasksfrom paver.path importar rathfrom ivaver.easy imports * Importar pavera.setuputilspaver.setuputils.install_distutils_tasks.stall_distutils_tasks () Intente: desde SphinxContrib Import paverutilsexcept: adver advertencias advertencias. Advirtió ('SphinxContrib.Paverutils no se encontró, no podrá producir documentación') Opciones (Setup = Bunch (Name = 'MyProject', Version = '1.0', # ... Más opciones Aquí ...), # por defecto para sphinxcontontrib.paverutils sphinx = manojo (DoCroot = '.', SourceCedir = 'Docsource', Builder = 'html',), # una configuración para construir HTML para el paquete HTML = MOUNG (Builddir = 'docs', confiltir = 'sphinx / pkg',), # otra configuración w Con diferentes plantillas # para construir HTML para cargar en el sitio web sitio web = Bunch (BuildDir = 'Web', ConfDir = 'Sphinx / Web',), # También queremos un archivo PDF para el sitio web, # para que las instrucciones se incluyen en El directorio de configuración web #. PDF = Bunch (Builddir = 'Web', Builder = 'Latex', ConfDir = 'Sphinx / Web',),) Parámetros de configuraciónDocroot La raíz debajo de la cual funcionará la esfinge. Predeterminado: DOCSBUILDDIR directorio bajo el Doccroot donde se colocan los archivos resultantes. Predeterminado: BuildSourCedir Directorio bajo el Doccorto para los archivos de origen Predeterminado: (Cadena vacía) Doctertes La ubicación de los doctrees en caché Predeterminado: $ BuildDir / DocTreesConfDIR La ubicación de la SphinX Conf.py Predeterminado: $ SourGedirutDir La ubicación de los archivos de salida generados predeterminados : $ builddir / $ builderbuilder El nombre del constructor de Sphinx para usar Predeterminado: HTMLTEMPLY_ARGS Diccionario de valores que se transmitirá como pares de valores de nombre al defecto de HTML Builder: {} Advanced Usageyou también puede desarrollar sus propias tareas llamando a RUN_SPHINX () directamente : @ tarea @ necesidades () @ cmdopts () Def Blog (Opciones): "" "Generar la versión posterior del blog del HTML para el módulo actual". "" # Generar HTML de Sphinx Paverutils.Run_sphinx (Opciones,' Blog ') Blog_File = Ruta ( opt opt ​​opts.blog.utdir) / opciones.blog.out_file seco ("Escribir blog de blog corporal a% s"% blog_file, gen_blog_post, supervasos = opt option.blog.outdir, input_base = option.blog .in_file, blog_base = options.blog.out_file,) Si 'editor' en os.environ: sh ('$ editor% s'% blog_file) Requisitos de retorno: · Python ¿Qué hay de nuevo en este lanzamiento: · Actualizado para incluir la función run_script ().

SphinxContrib-Paverutils Software relacionado