Comment configurer buildout pour créer des documents en utilisant sphynx bin/sphinxbuilder

Question

Dans mon fichier buildout.cfg j'ai un tel code:

parts = 
    ... 
    sphinxbuilder 

suivant dans la même fichier:

eggs= 
    ... 
    jinja2 
    markupsafe 
    sphinx 

puis, à la fin du fichier:

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

que je fais:

bin/buildout 

qui donne une sortie (en général: OK):

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

Dans le dossier oeufs j'ai Sphinx électroencéphalogramme.

Après buildout, dans le répertoire du projet j'en ai un, nouveau catalogue: docs. alors je cours commande:

bin/sphinx-quickstart 

et comme root path for the documentation je mis docs

puis-je modifier docs/conf.py et uncomment

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

je lance la commande bin/sphinxbuilder et obtenir l'erreur:

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. 

Problèmes principaux: (1) Comment faire fonctionner le sphinx automatiquement avec buildout? (2) Comment définir le bon chemin vers les modules de projet (applications) dans les fichiers .rst? (3) Où mettre le fichier conf.py?

Answer 1

Sur les fenêtres ici, mais je semble rappeler un problème similaire.

étendre le cfg suivant assure deux choses: 1) tous les points d'entrée, nous générons avoir accès aux œufs de sphinx 2) parties qui comptent sur les points d'entrée de sphinx seront exécutés -after- les points d'entrée sont générés

[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} 

Avec cela, vous pouvez également ajouter des pièces qui se fondent sur la construction/executables de aPIDOC et votre génération de documentation devient partie d'un seul clic buildout:

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