Vielleicht könnt ihr mich da mal in die richtige Richtung drehen?
Es handelt sich bei meinem Code nicht um eine Bibliothek, sondern um eine simple GUI-Anwendung mit SQLAlchemy(sqlite3) backend. Es soll auch irgendwann mal veröffentlicht (GitHub) werden. Insgesamt ist es aber eine Art Selbstlernprojekt - zu Python3, div. Programmier- und Design-Techniken, git, Projektmanagement und eben auch docu-Generierung.
Wichtig ist, das die doc-strings im Code auch für Menschen noch lesbar sind. reStructuredText nutze ich bereits andernorts und finde es ganz brauchbar.
Die Frage ist, welche auto-doc tools das unterstützen usw. Unpraktisch/-lesbar finde ich es, wenn bei einer Klasse, jedes Attribut einen einzelnen doc-string erhält. Ich würde die Attribute gerne im Klassen-Docstring mit einbauen. Das ist im code leichter zu lesen.
Weiterhin sollte es auch möglich sein den Datentyp von Methoden-Argumenten oder Klassen-Attributen festlegen zu können.
Wie wertet ihr z.B. die in-code Lesbarkeit zwischen Doxygen und Sphinx?
Worauf sollte ich meine Energie jetzt konzentrieren?