08.03.2011

Data Dictionary mit Sphinx

Sphinx - Python Documentation Generator

Psaraas Sphinx
Overview

Die SCQM-Rheumadatenbank umfasst hunderte von Fragen und damit Datenbankfelder. Um den Überblick über alle Felder sowie deren Bezeichnungen, Werte und Enumerationen zu behalten, erstellen wir die Dokumentation aller Felder mit Sphinx.

Sphinx gereneriert den Data Dictionary automatisch aus den Interfaces im Code. So stellen wir sicher, dass die Dokumentation auch bei Weiterentwicklungen stets up-to-date bleibt.

Psaraas Sphinx Image

Die Dokumentation wird bei jedem Release online veröffentlich, so dass Forschende einfach Zugriff auf diese Informationen haben: http://docs.scqm.ch