Hilfedatei für Python-Programm schreiben

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.
groloma
User
Beiträge: 2
Registriert: Freitag 20. Juli 2007, 13:07

Hilfedatei für Python-Programm schreiben

Beitragvon groloma » Dienstag 25. September 2007, 12:39

Hallo, ich würde gerne Hilfe-Dateien für meine Python-Programme schreiben (unter Windows).
Gibt es irgendwo einen Hilfe-Dateien-Editor möglichst ohne restriktive Lizenz?
Also möglicht mit GPL-Lizenz oder ähnliches. Hab im Internet keinen freien gefunden.
rafael
User
Beiträge: 189
Registriert: Mittwoch 26. Juli 2006, 16:13

Beitragvon rafael » Dienstag 25. September 2007, 13:05

Was meinst du genau mit einer "Hilfe-Datei"? In einem Programm mit GUI-Oberfläche diesen typischen blauen Fragezeichen Button? Sowas ist mit PyGTK, wxWindows etc. möglich.
Benutzeravatar
C4S3
User
Beiträge: 292
Registriert: Donnerstag 21. September 2006, 10:07
Wohnort: Oberösterreich

Beitragvon C4S3 » Dienstag 25. September 2007, 13:06

Hallo!

Du solltest mit den "Batterien" von Python doch eigentlich schon recht weit kommen können, ohne zusätzliche Dinge zu benötigen.

Code: Alles auswählen

# in IDLE eingegeben:
import pydoc
help(pydoc)

Help on module pydoc:

NAME
pydoc - Generate Python documentation in HTML or text for interactive use.

FILE
c:\python25\lib\pydoc.py

DESCRIPTION
In the Python interpreter, do "from pydoc import help" to provide online
help. Calling help(thing) on a Python object documents the object.

Or, at the shell command line outside of Python:

Run "pydoc <name>" to show documentation on something. <name> may be
the name of a function, module, package, or a dotted reference to a
class or function within a module or module in a package. If the
argument contains a path segment delimiter (e.g. slash on Unix,
backslash on Windows) it is treated as the path to a Python source file.

Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines
of all available modules.

Run "pydoc -p <port>" to start an HTTP server on a given port on the
local machine to generate documentation web pages.

For platforms without a command line, "pydoc -g" starts the HTTP server
and also pops up a little window for controlling it.

Run "pydoc -w <name>" to write out the HTML documentation for a module
to a file named "<name>.html".

Module docs for core modules are assumed to be in

http://www.python.org/doc/current/lib/

This can be overridden by setting the PYTHONDOCS environment variable
to a different URL or to a local directory containing the Library
Reference Manual pages.
.... usw ....


Das könnte dir doch schon helfe, denke ich.

EDIT:
hier wurde das schon mal angesprochen, sehe ich gerade:
http://www.python-forum.de/topic-389.ht ... +erstellen

EDIT 2:
von M$ gibt es ein eher unbekanntes Tool, mit dem man HTML Dateien in das MS-eigene CHM-Format convertieren kann. Wenn du also einen Ordner mit zig HTML-Dateien hast, kannst du daraus dann eine CHM machen.
Erster Google-Treffer:http://www.rtfc.eu/rtfc0023.html
Gruß!
Benutzeravatar
gerold
Python-Forum Veteran
Beiträge: 5554
Registriert: Samstag 28. Februar 2004, 22:04
Wohnort: Telfs (Tirol)
Kontaktdaten:

Re: Hilfedatei für Python-Programm schreiben

Beitragvon gerold » Dienstag 25. September 2007, 13:46

groloma hat geschrieben:Gibt es irgendwo einen Hilfe-Dateien-Editor möglichst ohne restriktive Lizenz?

Hallo groloma!

Willkommen im Python-Forum!

Ich verwende ihn nicht, aber für Windows wahrscheinlich das Beste was du gratis bekommen kannst: HelpMaker http://www.vizacc.com/

Wenn du Plattformunabhängige Hilfe schreiben möchtest, dann würde ich bei HTML bleiben.

mfg
Gerold
:-)
http://halvar.at | Kleiner Bascom AVR Kurs
Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
groloma
User
Beiträge: 2
Registriert: Freitag 20. Juli 2007, 13:07

Beitragvon groloma » Dienstag 25. September 2007, 14:39

ja danke, das werde ich alles mal ausprobieren

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder