Wie buildout konfigurieren Sphinx-Dokumentation Ich habe einen solchen Code mit bin/sphinxbuilder

Question

In meinem buildout.cfg-Datei zu erstellen:

parts = 
    ... 
    sphinxbuilder 

nächste in derselben Datei:

eggs= 
    ... 
    jinja2 
    markupsafe 
    sphinx 

und dann, am Ende der Datei:

[sphinxbuilder] 
recipe = collective.recipe.sphinxbuilder 
source = ${buildout:directory}/docs-src 
build = ${buildout:directory}/docs 

ich tun:

bin/buildout 

die Ausgabe gibt (im Allgemeinen: OK):

Updating sphinxbuilder. 
collective.recipe.sphinxbuilder: writing MAKEFILE.. 
collective.recipe.sphinxbuilder: writing BATCHFILE.. 
collective.recipe.sphinxbuilder: writing custom sphinx-builder script.. 

In Eier Ordner habe ich Sphinx eeg.

Nach buildout, unter Projektverzeichnis habe ich einen, neuen Katalog: docs. dann laufe ich Befehl:

bin/sphinx-quickstart 

und als root path for the documentation I docs

setzen dann bearbeite ich docs/conf.py und uncomment

sys.path.insert(0, os.path.abspath('.')) 

ich Befehl ausführen bin/sphinxbuilder und bekommen Fehler:

Makefile:12: *** The 'sphinx-build' command was not found. 
Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. 
Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/. Stop. 

Hauptprobleme: (1) Wie bekomme ich Sphinx automatisch mit Buildout? (2) Wie setze ich den richtigen Pfad zu Projektmodulen (Apps) in .rst-Dateien? (3) Wo wird die Datei conf.py abgelegt?

Answer 1

Auf Windows hier, aber ich erinnere mich an ein ähnliches Problem.

die folgenden cfg erstreckt sorgt für zwei Dinge: 1) Alle Einstiegspunkte haben wir Zugang 2) Teile die Sphinx Eier erzeugen, die auf den Sphinx Einstiegspunkten verlassen wird -after- diese Einstiegspunkte ausgeführt werden, erzeugt

[sphinx] 
eggs = 
    sphinx 
    <if you have theme eggs or other extensions, put em here> 

parts = 
    sphinx.console_scripts 

[sphinx.console_scripts] 
recipe = zc.recipe.egg 
dependent-scripts = true 
eggs = 
    ${sphinx.eggs} 
    ${buildout:eggs} 

diese verwenden, können Sie auch Teile hinzufügen, die Teil eines buildout auf den Build/apidoc ausführbaren Dateien und die Dokumentation Generation angewiesen wird mit einem Klick:

[sphinx.apidoc] 
recipe = plone.recipe.command 
command = ${buildout:bin-directory}\sphinx-apidoc.exe <all your flags/settiongs based on buildout>