Sphinx-Installation und Konfiguration

Mit dem Python Documentation Generator lassen sich einfach Dokumentationen für Python-Eggs erstellen.

Installation

Sphinx lässt sich einfach mit dem Buildout-Rezept collective.recipe.sphinxbuilder installieren:

[buildout]
parts =
    …
    sphinx

[sphinx]
recipe = collective.recipe.sphinxbuilder
interpreter = ${buildout:directory}/bin/zopepy

Konfiguration

Die initiale Dokumentation kann erstellt werden mit:

$ ./bin/sphinx-quickstart

Anschließend werden Sie aufgefordert, einige Fragen zu beantworten:

…
> Root path for the documentation [.]:
> Separate source and build directories (y/N) [n]: y
…
> coverage: checks for documentation coverage (y/N) [n]: y
…

Die Dokumentation kann nun erstellt werden mit:

$ ./bin/sphinxbuilder