Naja, es gibt ja auch noch die Offtopic-Section, in der sich so ziemliches alles unterbringen lässt - sofern es irgend einen Bezug zur IT hatbennnil hat geschrieben:Ich wollte nicht hier fragen, da das Forum sich doch eigentlich mit Python beschäftigt, oda?
Sphinx dient zur Dokumentation von Softwareprojekte. Punkt. Sphinx ist dabe sehr "pythonisch", weil es eben aus dem direkten Pythonumfeld kommt. Als Markupsprache wird reStructured Text verwendet, welches ebenfalls aus dem direkten Pythonumfeld kommt.Dabei kommt es weniger auf die Programmiersprache, als auf die Möglichkeiten, die man mit Sphinx hat an
erkenne ich aber nicht... was hat "Quelltext Vereinheitlichung" mit Dokumentation zu tun? Oder muss du für ein Projekt Coding-Guidelines erstellen?Ich muss für ein Projekt zur Softwarequalität (Quelltext Vereinheitlichung ... ) mich etwas genauer über Sphinx informieren.
Ja da hast du vermutlich mit recht, aber es ist nunmal meine Aufgabe ohne das Programmieren zu können zu beschreiben ... über Sinn und Unsinn dieser Aufgabe will ich auch nichts sagen.Sphinx ist primär zum Dokumentieren von Python-Projekten gedacht und deshalb dürfen die Entwickler beim schreiben der Dokumentation IMHO auch voraussetzen, dass man Ahnung von Python hat, bevor man damit ein Python-Projekt dokumentiert. Das wäre doch unnötig doppelte Arbeit Sachen zu beschreiben für die es schon andere, gute Tutorials und Dokumentation gibt.
das hätte ich genauer sagen können.http://tutorial.pocoo.org/bennnil hat geschrieben:Habt ihr als erfahrene Programmierer ein Tutorial an der Hand, mit dem ich den Einstieg schnell schaffe?
@ noisefloor(die Frage habe ich vergessenSphinx dient zur Dokumentation von Softwareprojekte. Punkt. Sphinx ist dabe sehr "pythonisch", weil es eben aus dem direkten Pythonumfeld kommt. Als Markupsprache wird reStructured Text verwendet, welches ebenfalls aus dem direkten Pythonumfeld kommt.
)Dir ist schon klar, dass Software-Projekte nicht immer aus grafischen Oberflächen bestehen und dass, selbst wenn eine GUI besteht, meist noch eine darunter gelegte Ebene existiert, welche die Interna des Programms vollzieht? Bei einer reinen Bibliothek ist der Anwender sozusagen der Programmierer, welcher die Bibliothek einsetzt. Zudem ist es keinesfalls unüblich, dass in Firmen verwendete Software häufig entsprechend den eigenen Anforderungen angepasst werden müssen. Wären die Programmteile da nicht (mehr oder weniger) detailliert dokumentiert, dann würde der Aufwand für den Benutzer enorm steigen, weil er nur durch Lesen des Quelltexts erfassen kann, zu welchem Zweck welche Funktion da ist. Das macht nicht wirklich Spass und steigert und nicht gerade die Popularität eines Projektes.bennnil hat geschrieben:Ich meine was bringt einem Benutzer eine Auflistung der verwendeten Klassen o.ä. ?
Ja, zumindest soweit ich weiß. Sphinx "durchforstet" nicht den Quellcode nach Kommentaren und baut daraus eine automatisch Doku. Das gibt's auch. Die Qualität der Doku hängt dann aber natürlich direkt davon ab, wie Code die Kommentare im Quellcode sind.Bedeutet das, dass Sphinx nur die reST formatierten Texte umwandelt
Dann sag mir doch bitte wie das Programm heißtDas gibt's auch. Die Qualität der Doku hängt dann aber natürlich direkt davon ab, wie Code die Kommentare im Quellcode sind.
Leider ist das nicht so einfach. Meine Aufgabe ist ja eben Sphinx zu untersuchen und dessen Möglichkeiten aufzuzeigen. Ich soll ja keine Dokumentation über ein Programm schreiben.Basierend auf deinem letzten Posting würde ich aber sagen: Du willst und brauchst gar nicht Sphinx benutzen. Nimm' besser ein Wiki, bei dem man die Syntax / Markup in 5 min lernen kann und schreib' die Doku dort hin.
http://sphinx.pocoo.org/ext/autodoc.htmlbennnil hat geschrieben: Dann sag mir doch bitte wie das Programm heißt
