Added docstrings for various modules, removed unnecessary data classes, etc.

Author: PierreRaybaut

doc/index.rst

@@ -7,6 +7,7 @@ Contents:
     :maxdepth: 2
 
     overview
+    limitations
     installation
     examples/index
     reference/index

doc/overview.rst

@@ -25,6 +25,31 @@ only plot items needed by `guiqwt`): `QwtPlotItem` (base class),
 `QwtPlotItem`, `QwtPlotMarker`, `QwtPlotSeriesItem`, `QwtPlotHistogram`, 
 `QwtPlotCurve`.
 
+The `HistogramItem` object implemented in PyQwt's HistogramDemo.py is not 
+available here as a similar item is already implemented in `guiqwt`. As a 
+consequence, the following classes are not implemented: `QwtPlotHistogram`, 
+`QwtIntervalSeriesData`, `QwtIntervalSample`.
+
+The following data structure objects are not implemented as they seemed not 
+relevant with Python and NumPy: `QwtCPointerData` (As a consequence, method 
+`QwtPlot.setRawSamples` is not implemented), `QwtSyntheticPointData`.
+
+The following sample data type objects are not implemented as they seemed 
+quite specific: `QwtSetSample`, `QwtOHLCSample`. For similar reasons, the 
+`QwtPointPolar` class and the following sample iterator objects are not 
+implemented: `QwtSetSeriesData`, `QwtTradingChartData`, 
+`QwtPoint3DSeriesData`, `QwtArraySeriesData`, `QwtPointSeriesData`.
+
+Threads:
+
+    - Multiple threads for graphic rendering is implemented in Qwt C++ code 
+      thanks to the `QtConcurrent` and `QFuture` Qt features which are 
+      currently not supported by PyQt.
+    - As a consequence the following API is not supported in `python-qwt`:
+        - `QwtPlotItem.renderThreadCount`
+        - `QwtPlotItem.setRenderThreadCount`
+        - option `numThreads` in `QwtPointMapper.toImage`
+
 The `QwtClipper` class is not implemented yet (and it will probably be 
 very difficult or even impossible to implement it in pure Python without 
 performance issues). As a consequence, when zooming in a plot curve, the 

doc/reference/index.rst

@@ -17,8 +17,13 @@ Main `python-qwt` classes:
     plot_curve
     plot_directpainter
     plot_grid
-    plot_histogram
     plot_layout
     plot_marker
     plot_renderer
     plot_seriesitem
+    scale_div
+    scale_draw
+    scale_engine
+    scale_widget
+    series_data
+    toqimage

doc/reference/scale_div.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.scale_div
+   :members:

doc/reference/scale_draw.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.scale_draw
+   :members:

doc/reference/scale_engine.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.scale_engine
+   :members:

doc/reference/scale_widget.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.scale_widget
+   :members:

doc/reference/series_data.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.series_data
+   :members:

doc/reference/toqimage.rst

@@ -0,0 +1,2 @@
+.. automodule:: qwt.toqimage
+   :members:

qwt/__init__.py

@@ -45,12 +45,10 @@
 from qwt.scale_div import QwtScaleDiv
 from qwt.scale_draw import QwtScaleDraw
 from qwt.scale_draw import QwtAbstractScaleDraw
-from qwt.series_data import QwtIntervalSeriesData
-from qwt.sample import QwtIntervalSample
 from qwt.painter import QwtPainter
 from qwt.legend_data import QwtLegendData
 
-from qwt.point_data import QwtPointArrayData
+from qwt.series_data import QwtPointArrayData
 
 from qwt.plot_renderer import QwtPlotRenderer