python: Add documentation generation.

.gitignore

@@ -64,6 +64,7 @@ bindings/python/sigrok/core/lowlevel_wrap.c
 bindings/python/sigrok/core/classes.py
 bindings/python/sigrok/core/classes_wrap.cpp
 bindings/python/timestamp
+bindings/python/doxy/
 
 # Files generated by building Java bindings
 *.class

Makefile.am

@@ -467,6 +467,10 @@ python-install:
 python-clean:
 	$(AM_V_at)$(MAKE) python-quietclean
 	$(AM_V_at)rm -f $(PDIR)/timestamp
+	$(AM_V_at)rm -rf $(PDIR)/doxy/
+
+python-doc:
+	$(AM_V_at)cd $(PDIR) && doxygen Doxyfile
 
 BUILD_EXTRA += python-build
 INSTALL_EXTRA += python-install

bindings/python/sigrok/core/classes.i

@@ -17,7 +17,32 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-%module classes
+%define DOCSTRING
+"@mainpage API Reference
+
+Introduction
+------------
+
+The pysigrok API provides an object-oriented Python interface to the
+functionality in libsigrok. It is built on top of the sigrok++ C++ API.
+
+Getting started
+---------------
+
+Usage of the pysigrok API needs to begin with a call to Context.create().
+This will create the global libsigrok context and returns a Context object.
+Methods on this object provide access to the hardware drivers, input and output
+formats supported by the library, as well as means of creating other objects
+such as sessions and triggers.
+
+Error handling
+--------------
+
+When any libsigrok C API call returns an error, an Error exception is raised,
+which provides access to the error code and description."
+%enddef
+
+%module(docstring=DOCSTRING) classes
 
 %{
 #include <pygobject.h>