Jak skonfigurować buildout stworzyć sfinks dokumentacji przy użyciu bin/sphinxbuilder

Question

W moim buildout.cfg pliku mam taki kod:

parts = 
    ... 
    sphinxbuilder 

Następny w samym pliku:

eggs= 
    ... 
    jinja2 
    markupsafe 
    sphinx 

a potem, na końcu pliku:

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

Robię:

bin/buildout 

który daje wyjście (ogólnie: OK):

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

W folderze jaj mam Sphinx EEG.

Po buildout, w katalogu projektu mam jeden nowy katalog: docs. następnie uruchomić komendę:

bin/sphinx-quickstart 

i jak root path for the documentation ustawić docs

następnie edytować docs/conf.py odkomentowane

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

biegnę polecenie bin/sphinxbuilder i dostać błąd:

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. 

Główne problemy: (1) Jak sprawić, by sfinks działał automatycznie z budową? (2) Jak ustawić właściwą ścieżkę do modułów projektu (aplikacji) w plikach .rst? (3) Gdzie umieścić plik conf.py?

Answer 1

W przypadku okien tutaj, ale wydaje mi się, że przypominają podobny problem.

rozszerzenie następujące cfg zapewnia dwie rzeczy: 1) wszystkie punkty wejścia możemy generować mieć dostęp do jaj Sphinx 2) części, które opierają się na zostanie wykonany -after- tych punktów początkowych punkty wejścia Sphinx są generowane

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

Korzystanie z tym, można również dodać elementy, które polegają na gromadzeniu wykonywalnych/apidoc a pokolenie dokumentacja staje się częścią jednego kliknięcia buildout:

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