Sphinx Dokumentation: FEHLER: Unbekannte Anweisung Typ "Programm-Ausgabe"

Question

Ich versuche, meine Dokumente mit Sphinx zu erstellen, und jetzt auf zwei Maschinen habe ich genau das gleiche Problem: Die Programm-Output-Direktive funktioniert nicht.

Ich installierte Sphinx, dann ist die programoutput Erweiterung:

$ sudo pip install sphinxcontrib-programoutput 

Die Installation geklappt hat, Dokumente zusammenstellen schön zu gut aussehende HTML, aber der Befehl-Ausgabe funktioniert einfach nicht.

habe ich einen super-einfachen Testfall mit einer Datei test.rst enthält eine einzelne Zeile genannt:

.. program-output:: python -V 

Jetzt

wenn dies zu kompilieren versuchen, ich die folgende Ausgabe (Pfad abgekürzt) erhalten:

/path/to/test.rst:1: ERROR: Unknown directive type "program-output". 

Das Ändern der Programmausgabe in den Alias-Befehlsausgang funktioniert ebenfalls nicht (nicht überraschend). Ich frage mich wirklich, was ich hier falsch mache. Ich habe die Installationsanweisungen befolgt, es immer wieder versucht, mit einem --upgrade Flag neu installiert, nichts geht.

Answer 1

Dank bmu habe ich das Problem gefunden, in der Tat musste ich es zum conf.py hinzufügen.

Jetzt die nächste Frage: "Warum ist das nicht in der Installation/Nutzung Dokumentation dieser Erweiterung?" Es ist nicht in http://packages.python.org/sphinxcontrib-programoutput/ erwähnt, das ist die erste Verbindung, die ich beim googlen für diese Erweiterung bekomme.

Wie auch immer die vollständige Antwort, hoffen, dass es auch für andere Menschen nützlich ist:

Zum Dokument Wurzel Ihrer Dokumentation (z ~/Projects/project-name/doc), wo der Rest Ihrer Dokumente sind.

Datei bearbeiten conf.py

Suchen Sie die Zeile, die extensions = [] (eine leere Liste in meinem Fall) sagt

Ändern Sie diese an: extensions = ['sphinxcontrib.programoutput']

Und es beginnt wie durch ein Wunder plötzlich zu arbeiten.