Seite 1 von 1

Sphinx Dokumentation Warnung bei Annotation

Verfasst: Sonntag 6. Februar 2011, 11:40
von Boa
Hi,

Ich habe angefangen mein Projekt mit Sphinx zu dokumentieren. Das Problem ist, dass das Framework nicht mit meinen Annotationen klarkommt:
(WARNING/2) autodoc can't import/find module 'my_module', it reported error: "name 'my_annotationname' is not defined", please check your spelling and sys.path
my_annotationname ist dabei die Annotation, mit der ich eine Methode in my_module kennzeichne.
Weiter vorher kommt die Meldung:
[Stacktrace]
File "my_module_path", line 36, in my_module
@my_annotationname
NameError: name 'my_annotationname' is not defined
Wie kann ich diese Fehlermeldung ignorieren? Es ist ja falscher Alarm soweit ich es verstehe. Denn sonst wird die Dokumentation für dieses Modul nicht erstellt.

Vielen Dank,
Boa

Re: Sphinx Dokumentation Warnung bei Annotation

Verfasst: Sonntag 6. Februar 2011, 11:47
von DasIch
Diese "Annotationen" heissen Dekoratoren, dass beim importieren ein NameError ausgelöst wird heisst dass dein Modul nicht ausführbar ist und Sphinx kann es deswegen nicht dokumentieren, da es dafür (teilweise) Objekte zur Laufzeit untersucht.

Re: Sphinx Dokumentation Warnung bei Annotation

Verfasst: Sonntag 6. Februar 2011, 12:02
von Boa
DasIch hat geschrieben:Diese "Annotationen" heissen Dekoratoren, dass beim importieren ein NameError ausgelöst wird heisst dass dein Modul nicht ausführbar ist und Sphinx kann es deswegen nicht dokumentieren, da es dafür (teilweise) Objekte zur Laufzeit untersucht.
Ich bin etwas Java geschädigt. Kein Wunder, dass ich mit dem Begriff Annotation der Suchmaschine keine brauchbaren Ergebnisse entlocken konnte. Ich hatte vergessen meinen Dekorator aus dem Modul meiner Superklasse zu importieren. Super, Vielen Dank für deine Hilfe.