Documentation

This API documentation can be found in the ./docs directory. HTML and PDF documentation is generated by the bash script makedocs.sh. To build the documentation, you need to have the following tools installed:

• epydoc 3.0 beta (install from source)
• latex (the packages tetex-bin and tetex-extra in Ubuntu)
• docutils

Then just run the script:

$ ./makedocs.sh

The source for the documentation is found in the ./docs/gtkimageview.py file.

Keep in mind that this documentation is not built from the library source. This is because while epydoc does support generating documentation from extension modules, the result is generally very poor (GTK+ and PyGTK is partially to blame for that).

Epydoc has no support for extracting documentation for signals, which is why signals are here documented as methods prefixed with sig_*. For example, the description for the signal "pixbuf-changed" is found in the method description ImageView.sig_pixbuf_changed.

The examples should make it clear how these signals are supposed to be used.

For that reason, epydoc cannot automatically discern which GTK+ classes GtkImageView's classes subclass. Instead, see the class descriptions for inheritance information.

Release history

Major changes between version of PyGtkImageView. For a complete history, also see the Release history document in GtkImageView.