SphinxContrib-Paverutils Intégration SPHINX / PAVEUR
Télécharger maintenant

SphinxContrib-Paverutils Classement & Résumé

SphinxContrib-Paverutils Mots clés

Bibliothèque Python Python Sphinx pavé intégration de pavé Intégration SPHINX

SphinxContrib-Paverutils La description

Intégration Sphinx / Paver SPHINXCONTRIB-PAREUTILS est un module Python qui fournit une alternative intégration de Sphinx et de Paver. Il prend en charge appeler Sphinx à partir de Paver à l'aide de plusieurs configurations, et ne suppose pas que vous souhaitez uniquement créer une sortie HTML.Basic USAGETO Utilisez ce module, importez-le dans votre pavement.py fichier comme de SphinxContrib Import Import PAREUTILS, puis définissez les ensembles d'options pour "HTML "Et / ou" PDF "Sortie à l'aide des options décrites dans l'aide de la tâche.Pour Exemple: Importer Paverimport Paver.MisctTasksfrom Paver.Path Importer Pathfrom Paver.Rease Import * Importation paver.setutilspaver.setutils.install_distutils_tasks () Essayez: de SPHINXCONTRIB IMPORTATION PAREUTILSEXCEPT: AVERTISSEMENTS IMPORTS AVERTISSEMENTS.WARN ('SPHINXCONTRIB.PAVERUTILUILS N'ÉTAIT PAS PRODUCTION DE DOCUMENTATION') OPTIONS (SETUP = BUNCH (NOM = 'MYPROJECT', version = '1.0', # ... Plus d'options Ici ...), # Les valeurs par défaut pour sphinxtrib.paverutils sphinx = BUNCH (DOCROOT = '.', SOURCEDIR = 'DOCSOURCE', BUILDER = 'HTML',), # Une configuration pour construire HTML pour le package HTML = BUNCH (BuildDir) = 'DOCS', CONFDIR = 'SPHINX / PKG',), # Une autre configuration w avec des modèles différents # pour créer HTML à télécharger sur le site Web Site Web = BUCKDIR = 'BuildDir =' Web ', Confdir =' Sphinx / Web ',), # Nous voulons également un fichier PDF pour le site Web, de sorte que les instructions sont donc incluses dans les instructions. Le répertoire de configuration de Web #. pdf = bouquet (buildDir = 'web', constructeur = 'latex', confdir = 'sphinx / web',),) paramètre de configurationDocroot La racine sous laquelle Sphinx fonctionnera. Valeur par défaut: DocSbuildDir Directory sous le docroot où les fichiers résultants sont mis. Valeur par défaut: Répertoire de construction Sous le docroot pour les fichiers source Défaut par défaut: (String vide) Doctraches L'emplacement de la mise en cache des Doctraches par défaut: $ BuildDir / doctroesconfdir L'emplacement du SPHINX CONF.PY DEFAULT: $ SourceDirOutDir L'emplacement des fichiers de sortie générés par défaut : $ builddir / $ builderbuilder Nom du Builder Sphinx Pour utiliser Par défaut: HTMLTemplate_args Dictionnaire des valeurs à transmettre en tant que paires de noms de noms sur le fichier HTML Builder par défaut: {} USAGEDYOUVous pouvez également développer vos propres tâches en appelant Run_sphinx () directement. : @ Tâche @ Besoins () @ cmdopts () Blog def (Options): "" "Générez la version du blog Publier du HTML pour le module actuel." "" # Générer HTML de Sphinx Paverutils.Run_sphinx (options, "blog") blog_file = chemin ( Options.Blog.outdir) / Options.Blog.out_file Dry ("Écrire le corps de poteau de blog à% s"% blog_file, Gen_Blog_post, surponci = options.blog.outdir, entrée_base = options.blog .in_file, blog_base = options.blog.out_file,) si "éditeur" dans OS.Environ: SH ($ Editeur% S '% blog_file) Configuration requise: · Python Quoi de neuf dans cette version: · Mis à jour pour inclure la fonction Run_script ().

SphinxContrib-Paverutils Logiciels associés