Tkinter help viewer

Question

I have a simple Tkinter app in Python. I'd like to add help document to it; what is the simplest way to integrate an help viewer to the app? Preferably cross-platform (although I primarily use Windows)?

I can imagine writing the help in plain HTML.

Answer 1

You could stick with writting in html, and then using something like this: Tkhtml which displays html pretty well and is fairly lightweight. :)

And here is the python wrapper. I hope this helps.

Answer 2

Or just launch an external web browser, using the webbrowser module from the standard library.

import webbrowser
webbrowser.open('/path/to/help/file.html')

For writing your documentation, have a look at sphinx.