Dokumentation in Python mit Grafiken

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Dienstag 2. Dezember 2008, 13:55

Hallo liebes Python Forum,

vorab, ich benutze momentan Epydoc zur Dokumentation, aber das ist leider nicht ausreichend genug. Um meinen Quelltext auf für nicht Entwickler zugängig zu machen suche ich nach einer möglichkeit Grafiken in die Dokumentation zu übernehmen, da dann einige Vorgänge leichter zu verstehen sind.

Gibt es in dieser Richtung eine Möglichkeit ?

Ich danke für Antworten :)
lunar

Dienstag 2. Dezember 2008, 14:22

http://sphinx.pocoo.org/

Das wird auch für die Python-Dokumentation benutzt.
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Dienstag 2. Dezember 2008, 14:51

danke dir, aber könntest du mir eventuell auch sagen wie ich dort ein Bild in eine Dokumentation einbinden würde ?
derdon
User
Beiträge: 1316
Registriert: Freitag 24. Oktober 2008, 14:32

Dienstag 2. Dezember 2008, 15:21

Sphinx nutzt reStructuredText also werden Bilder so eingebunden wie in der reStructuredText-Referenz angegeben.

EDIT: in der Sphinx-Doku steht auch was dazu: http://sphinx.pocoo.org/rest.html#images
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Dienstag 2. Dezember 2008, 16:28

Ich habe es mal versucht, aber leider bis jetzt kein erfolg.
Hier mal mein Sample:

Code: Alles auswählen


__docformat__ = "restructuredtext de"

zaehl = 0
def zaehlr(anzahl):
  """Dokumentation start
  Diese Funktion dokumentiert , das Sie die Schleife
  solange durchlaeuft bis Anzahl erreicht wurde
  

    
  .. image::  sonnenuntergang.jpg
  """
  
  
  for i in range(anzahl):
    print anzahl


zaehlr(300)  
Was mache ich da falsch ?
lunar

Dienstag 2. Dezember 2008, 17:39

In der Dokumentation von Sphinx steht, wie man Bilder einbindet, und welche Erweiterung Docstrings in die Dokumentation aufnimmt bzw. wie man diese konfiguriert. Wenn du dich an diese Dokumentation gehalten hast, und der Buildprozess fehlschlägt, dann solltest detaillierte Informationen über Fehlermeldung und Umgebung posten.
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Dienstag 2. Dezember 2008, 19:38

Nein, ich glaube ich hab mich vorhin total schlecht ausgedrückt ^^
Ich bin schon mit dem egg unter Python 2.6 bei der installation gescheitert.
ich weis nicht genau wie ich das einbinden muss und genauso wenig wie
ca. so ein buildbefehl aussieht. Könntest du mir eventuell da weiterhelfen... immer langsam bitte da ich das auf arbeit ausprobieren muss :)

Danke für dein Verständnis ^^
nemomuk
User
Beiträge: 862
Registriert: Dienstag 6. November 2007, 21:49

Dienstag 2. Dezember 2008, 19:47

warum bist du gescheitert?
Was spricht gegen ein einfaches "easy_install sphinx"?

@lunar: wo ist denn dein easy_uninstall? kann es nicht mehr finden...
lunar

Dienstag 2. Dezember 2008, 19:53

@SchneiderWeisse
http://files.lunaryorn.de/view/code/easy_uninstall.py

@Florian F.
"easy_install sphinx", danach das Sphinx-Intro und anschließend den Rest der Dokumentation lesen.
nemomuk
User
Beiträge: 862
Registriert: Dienstag 6. November 2007, 21:49

Dienstag 2. Dezember 2008, 19:55

danke...
lässt sich irgendwie nicht mehr über die Suche auf deiner Seite finden...
lunar

Dienstag 2. Dezember 2008, 20:07

SchneiderWeisse hat geschrieben:danke...
lässt sich irgendwie nicht mehr über die Suche auf deiner Seite finden...
Die Suche erfasst auch nur den Teil, der mit Sphinx erstellt wurde, sprich alles unter www.lunaryorn.de. files.lunaryorn.de basiert zwar auf den Sphinx-Templates, die Suche zu erweitern ist allerdings ein bisschen komplexer als nur die Templates zu verwenden, und dazu hatte ich einfach keinen Bock ;) Vor allem, weil ich nicht so viel Ahnung von Java-Script habe ;)
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Donnerstag 4. Dezember 2008, 10:02

Hallo, nochmal ^^

ich hab mittlerweile Sphinx zum laufen bekommen :)
Jetzt ist nur noch die Frage wie mein Buildcommand aussehen muss, damit z.b. alle dateien innerhalb des Verzeichnisses:
C:\workspace\Ka\src
Dokumentiert werden und in das Verzeichnis:
C:\workspace\Ka\src\documentation
gepackt werden ?
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Donnerstag 4. Dezember 2008, 14:55

Kann mir da keiner weiterhelfen ?
Bzw wie sieht der Buildcommand bei euch aus ?
Wo liegen dabei eure py dateien ?
Florian F.
User
Beiträge: 11
Registriert: Mittwoch 8. Oktober 2008, 08:23

Donnerstag 4. Dezember 2008, 16:11

Also ich habe eine Möglichkeit gefunden wie ich Epydoc weiter nutzen kann und zusätzlich Grafiken einfügen kann. Ich habe jedoch das Problem das, wenn ich ReStructuredText benutze, dass meine kompletten Formatierungen weg sind. Leider sind das mehere Hundert dateien die ich nicht unbedingt ändern möchte -.-

Hat jemand vielleicht eine idee wie ich einen teil des dokuments im plaintext haben möchte und den anderen als ReStructuredText ?
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Donnerstag 4. Dezember 2008, 17:46

Florian F. hat geschrieben:Kann mir da keiner weiterhelfen ?
Doch sicherlich, aber wenn du Hilfe innerhalb von 4 Stunden erwartest, ist das schon etwas knapp. Schließlich ist noch nicht einmal Feierabend und einige Leute müssen arbeiten und können erst abends Fragen beantworten. Ansonsten solltest du dich an den kostenpflichtigen Sphinx-Support wenden ;)
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Antworten