SPHINXCONTRIB-PAVERUTILS. Sphinx / Fertiger Integration
Jetzt downloaden

SPHINXCONTRIB-PAVERUTILS. Ranking & Zusammenfassung

SPHINXCONTRIB-PAVERUTILS. Stichworte

Python-Bibliothek Python Sphinx Paver Integration des Fertigers Sphinx-Integration.

SPHINXCONTRIB-PAVERUTILS. Beschreibung

Sphinx / Paver Integration sphinxcontrib-paverutils ist ein Python-Modul, das eine alternative Integration von Sphinx und Fertiger stellt. Es unterstützt Sphinx aus Fertiger mit mehreren Konfigurationen aufrufen, und nicht annehmen, dass Sie nur HTML output.Basic UsageTo dieses Modul verwenden, importieren Sie es in Ihrem pavement.py Datei ab sphinxcontrib Import paverutils, dann definieren Option Bundles für html aufbauen wollen "und / oder "pdf" ausgegeben, um die Optionen in der Task help.For Beispiel beschrieben: import paverimport paver.misctasksfrom paver.path Import pathfrom paver.easy import * Import paver.setuputilspaver.setuputils.install_distutils_tasks () versucht: von sphinxcontrib Import paverutilsexcept: import Warnungen warnings.warn ( 'sphinxcontrib.paverutils wurde nicht gefunden, werden Sie nicht in der Lage sein, Dokumentation') zu erzeugen Optionen (setup = Bunch (name = 'MyProject', version = '1.0', # ... mehr Optionen hier ...), # Defaults für sphinxcontrib.paverutils Sphinx = Bunch (docroot = ' ' sourcedir =' DocSource', Baumeister = 'html',), # Eine Konfiguration zu bauen HTML für das Paket html = Bunch (builddir = 'docs', Confdir = 'Sphinx / PKG',), # Eine andere Konfiguration w ith verschiedenen Vorlagen # zu bauen HTML Upload in auf der Website Website = Bunch (builddir = 'web', Confdir = 'Sphinx / web') # Wir enthalten sind auch eine PDF-Datei, so dass die Anweisungen für die Website, # wollen das Web-# Konfigurationsverzeichnis. pdf = Bunch (builddir = 'Web', Builder = 'latex', Confdir = 'Sphinx / web')) Konfiguration Parametersdocroot die Wurzel unter denen Sphinx arbeiten werden. Standard: docsbuilddir Verzeichnis unter dem docroot wo die resultierenden Dateien gesetzt werden. Standard: buildsourcedir Verzeichnis unter dem docroot für die Quelldateien Standard: (leere Zeichenkette) doctrees die Position des zwischengespeicherten doctrees Standard: $ builddir / doctreesconfdir die Lage der Sphinx conf.py default: $ sourcediroutdir die Position des Standard erzeugten Ausgabedateien : $ builddir / $ builderbuilder der Name des Sphinx-Builder verwenden Standard: htmltemplate_args Wörterbuch von Werten als Name-Wert-Paare in die HTML-Builder Standardübergeben werden: {} Erweitert UsageYou kann durch den Aufruf run_sphinx () direkt Ihre eigenen Aufgaben auch entwickeln : @ Aufgabe @ Bedürfnisse () @ cmdopts () Blog def (Optionen): "" "generieren Sie die Blog-Post-Version des HTML-Code für das aktuelle Modul. """ # generiert html von Sphinx paverutils.run_sphinx (Optionen, 'Blog') blog_file = path ( options.blog.outdir) / options.blog.out_file trocken ( "Write Blogeintrag Körper zu% s" % blog_file, gen_blog_post, outdir = options.blog.outdir, input_base = options.blog .in_file, blog_base = options.blog.out_file,) wenn 'Editor' in os.environ: sh ( '$ EDITOR% s' % blog_file) return Anforderungen: · Python Was ist neu in dieser Version: · Aktualisiert run_script () Funktion enthalten.

SPHINXCONTRIB-PAVERUTILS. Zugehörige Software