sphinxcontrib-paverutils. Integrazione Sphinx / Paver
Scarica ora

sphinxcontrib-paverutils. Classifica e riepilogo

sphinxcontrib-paverutils. Tag

Libreria Python. Pitone Sfinge finitrice integrazione della finitrice Integrazione Sphinx.

sphinxcontrib-paverutils. Descrizione

Sfinge / integrazione della padroni SPHINXContrib-Paverutils è un modulo Python che fornisce un'integrazione alternativa della Sfinge e della finitrice. Supporta la chiamata Sphinx dall'interno della finitrice utilizzando più configurazioni e non si suppone che tu voglia solo creare output html.Basic USAGETO Utilizzare questo modulo, importarlo nel file pavement.py come da SPHINXCONTRIB import paverutils, quindi definisci i bundle di opzione per "HTML Output "e / o" PDF "utilizzando le opzioni descritte nell'apposizione dell'attività. Esempio: Importa Paverimport Paver.MisctSasksFrom Paver.Path Import Path-Paverfrom Paver. Facile importazione * import paver.setututilspaver.setututils.install_distutils_tasks () Prova: da Sfhinxcontrib Import Paverutilsexcept: import warnings warnings.warn ('sphinxcontrib.paverutils non è stato trovato, non sarà possibile produrre documentazione') Opzioni (Setup = BUNCH (NAME = "MyProject ', versione =' 1.0 ', # ... Altre opzioni qui ...), # predefiniti per sphinxcontrib.paverutils sphinx = bunch (docroot = '.', sournir = 'docsource', builder = 'html',), # una configurazione per creare HTML per il pacchetto HTML = BUNCH (BuildDir = 'Docs', Confdir = 'Sfhinx / Pkg',), # un'altra configurazione w Ith diversi modelli # per creare HTML per caricare sul sito web del sito Web = BUNCH (BuildDir = 'Web', Confdir = '' Sfhinx / Web ',), # Desidiamo anche un file PDF per il sito Web, # quindi le istruzioni sono incluse in la directory di configurazione Web #. PDF = BUNCH (BuildDir = 'Web', Builder = 'Latex', Confdir = 'Sfhinx / Web',),) Configurazione ParametriDocroot La radice sotto la quale Sfhinx lavorerà. Predefinito: Directory Docsbuilddir sotto Docroot dove vengono messi i file risultanti. Predefinito: Directory BuildSourcedir sotto Docroot per i file di origine predefinita: (Stringa vuota) Doctrees La posizione dei documenti memorizzati nella cache predefinita: $ BuildDir / Doctreesconfdir La posizione della sfinge conf.py predefinita: $ SourniRoutdir La posizione dei file di output generati predefiniti : $ BuildDir / $ BUILDERBUILDERSILDER Il nome del Builder Sphinx per utilizzare il dizionario predefinito: htmltemplate_args di valori da passare come coppie di valore del valore nominale del Builder HTML predefinito: {} Advanced Usageyou può anche sviluppare i propri compiti chiamando DUN_SPHINX () direttamente : @ Task @ ha bisogno () @ CMDOPTS () Blog DEF (opzioni): "" "Genera la versione del blog Post dell'Html per il modulo corrente." "" # Genera HTML da Sphinx Paverutils.Run_sphinx (Opzioni, "Blog") Blog_File = percorso ( opzioni.blog.outdir) / options.blog.out_file Dry ("Scrivi il Blog Post Body to% s"% Blog_File, Gen_Blog_Post, Outdor = Options.blog.outdir, Input_base = options.blog .in_file, blog_base = options.blog.out_file,) se 'editor' in Os.environ: sh ('$ editor% s'% blog_file) requisiti di ritorno: · Python. Cosa c'è di nuovo in questa versione: · Aggiornato per includere la funzione RUN_Script ().

sphinxcontrib-paverutils. Software correlato