Fixed documentation warnings during build (+ added preview script)

PierreRaybaut · PierreRaybaut · commit 1c421b2f55f0 · 2020-09-05T16:02:29.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ PythonQwt.chm
 PythonQwt.chm.zip
 doc.zip
 doctmp/
+settings.json
 
 # Created by https://www.gitignore.io/api/python
 
diff --git a/doc/reference/graphic.rst b/doc/reference/graphic.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.graphic
-   :members:
diff --git a/doc/reference/interval.rst b/doc/reference/interval.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.interval
-   :members:
diff --git a/doc/reference/plot.rst b/doc/reference/plot.rst
@@ -2,31 +2,23 @@ Plot widget fundamentals
 ------------------------
 
 .. automodule:: qwt.plot
-   :members:
 
 .. automodule:: qwt.plot_canvas
-   :members:
 
 Plot items
 ----------
 
 .. automodule:: qwt.plot_grid
-   :members:
 
 .. automodule:: qwt.plot_curve
-   :members:
 
 .. automodule:: qwt.plot_marker
-   :members:
 
 Additional plot features
 ------------------------
 
 .. automodule:: qwt.legend
-   :members:
 
 .. automodule:: qwt.color_map
-   :members:
 
 .. automodule:: qwt.plot_renderer
-   :members:
diff --git a/doc/reference/plot_directpainter.rst b/doc/reference/plot_directpainter.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.plot_directpainter
-   :members:
diff --git a/doc/reference/plot_layout.rst b/doc/reference/plot_layout.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.plot_layout
-   :members:
diff --git a/doc/reference/plot_series.rst b/doc/reference/plot_series.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.plot_series
-   :members:
diff --git a/doc/reference/scale.rst b/doc/reference/scale.rst
@@ -2,13 +2,9 @@ Scales
 ------
 
 .. automodule:: qwt.scale_widget
-   :members:
 
 .. automodule:: qwt.scale_div
-   :members:
 
 .. automodule:: qwt.scale_engine
-   :members:
 
 .. automodule:: qwt.scale_draw
-   :members:
diff --git a/doc/reference/symbol.rst b/doc/reference/symbol.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.symbol
-   :members:
diff --git a/doc/reference/text.rst b/doc/reference/text.rst
@@ -1,5 +1 @@
-Text
-----
-
 .. automodule:: qwt.text
-   :members:
diff --git a/doc/reference/toqimage.rst b/doc/reference/toqimage.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.toqimage
-   :members:
diff --git a/doc/reference/transform.rst b/doc/reference/transform.rst
@@ -1,2 +1 @@
 .. automodule:: qwt.transform
-   :members:
diff --git a/qwt/color_map.py b/qwt/color_map.py
@@ -232,6 +232,7 @@ class QwtLinearColorMap(QwtColorMap):
         :param int format_: Preferred format of the color map (:py:data:`QwtColorMap.RGB` or :py:data:`QwtColorMap.Indexed`)
     
     .. py:class:: QwtLinearColorMap(color1, color2, [format_=QwtColorMap.RGB]):
+        :noindex:
         
         Build a color map with two stops at 0.0 and 1.0.
         
diff --git a/qwt/dyngrid_layout.py b/qwt/dyngrid_layout.py
@@ -51,10 +51,12 @@ class QwtDynGridLayout(QLayout):
 		:param int spacing: spacing
 
     .. py:class:: QwtDynGridLayout(spacing)
+        :noindex:
     
 		:param int spacing: spacing
 
     .. py:class:: QwtDynGridLayout()
+        :noindex:
     
 		Initialize the layout with default values.
 	
diff --git a/qwt/graphic.py b/qwt/graphic.py
@@ -267,6 +267,7 @@ class QwtGraphic(QwtNullPaintDevice):
         Initializes a null graphic
         
     .. py:class:: QwtGraphic(other)
+        :noindex:
     
         Copy constructor
         
@@ -423,12 +424,14 @@ def defaultSize(self):
     def render(self, *args):
         """
         .. py:method:: render(painter)
+            :noindex:
         
             Replay all recorded painter commands
             
             :param QPainter painter: Qt painter
         
         .. py:method:: render(painter, size, aspectRatioMode)
+            :noindex:
         
             Replay all recorded painter commands
             
@@ -440,6 +443,7 @@ def render(self, *args):
             :param Qt.AspectRatioMode aspectRatioMode: Mode how to scale
         
         .. py:method:: render(painter, rect, aspectRatioMode)
+            :noindex:
         
             Replay all recorded painter commands
             
@@ -450,6 +454,7 @@ def render(self, *args):
             :param Qt.AspectRatioMode aspectRatioMode: Mode how to scale        
         
         .. py:method:: render(painter, pos, aspectRatioMode)
+            :noindex:
         
             Replay all recorded painter commands
             
@@ -599,6 +604,7 @@ def toPixmap(self, *args):
     def toImage(self, *args):
         """
         .. py:method:: toImage()
+            :noindex:
         
             Convert the graphic to a `QImage`
 
@@ -613,6 +619,7 @@ def toImage(self, *args):
             :return: The graphic as image in default size
 
         .. py:method:: toImage(size, [aspectRatioMode=Qt.IgnoreAspectRatio])
+            :noindex:
         
             Convert the graphic to a `QImage`
 
diff --git a/qwt/painter_command.py b/qwt/painter_command.py
@@ -70,12 +70,14 @@ class QwtPainterCommand(object):
         Construct an invalid command
         
     .. py:class:: QwtPainterCommand(path)
+        :noindex:
     
         Copy constructor
         
         :param QPainterPath path: Source
         
     .. py:class:: QwtPainterCommand(rect, pixmap, subRect)
+        :noindex:
     
         Constructor for Pixmap paint operation
         
@@ -84,6 +86,7 @@ class QwtPainterCommand(object):
         :param QRectF subRect: Rectangle inside the pixmap
         
     .. py:class:: QwtPainterCommand(rect, image, subRect, flags)
+        :noindex:
     
         Constructor for Image paint operation
         
@@ -93,6 +96,7 @@ class QwtPainterCommand(object):
         :param Qt.ImageConversionFlags flags: Conversion flags
         
     .. py:class:: QwtPainterCommand(state)
+        :noindex:
     
         Constructor for State paint operation
         
diff --git a/qwt/plot_curve.py b/qwt/plot_curve.py
@@ -417,6 +417,7 @@ def setPen(self, *args):
         Build and/or assign a pen, depending on the arguments.
         
         .. py:method:: setPen(color, width, style)
+            :noindex:
         
             Build and assign a pen
     
@@ -429,6 +430,7 @@ def setPen(self, *args):
             :param Qt.PenStyle style: Pen style
         
         .. py:method:: setPen(pen)
+            :noindex:
         
             Assign a pen
     
diff --git a/qwt/plot_grid.py b/qwt/plot_grid.py
@@ -221,6 +221,7 @@ def setPen(self, *args):
         Build and/or assign a pen for both major and minor grid lines
         
         .. py:method:: setPen(color, width, style)
+            :noindex:
         
             Build and assign a pen for both major and minor grid lines
     
@@ -233,6 +234,7 @@ def setPen(self, *args):
             :param Qt.PenStyle style: Pen style
         
         .. py:method:: setPen(pen)
+            :noindex:
         
             Assign a pen for both major and minor grid lines
     
@@ -263,6 +265,7 @@ def setMajorPen(self, *args):
         Build and/or assign a pen for both major grid lines
         
         .. py:method:: setMajorPen(color, width, style)
+            :noindex:
         
             Build and assign a pen for both major grid lines
     
@@ -275,6 +278,7 @@ def setMajorPen(self, *args):
             :param Qt.PenStyle style: Pen style
         
         .. py:method:: setMajorPen(pen)
+            :noindex:
         
             Assign a pen for the major grid lines
     
@@ -305,6 +309,7 @@ def setMinorPen(self, *args):
         Build and/or assign a pen for both minor grid lines
         
         .. py:method:: setMinorPen(color, width, style)
+            :noindex:
         
             Build and assign a pen for both minor grid lines
     
@@ -317,6 +322,7 @@ def setMinorPen(self, *args):
             :param Qt.PenStyle style: Pen style
         
         .. py:method:: setMinorPen(pen)
+            :noindex:
         
             Assign a pen for the minor grid lines
     
diff --git a/qwt/plot_marker.py b/qwt/plot_marker.py
@@ -536,6 +536,7 @@ def setLinePen(self, *args):
         Build and/or assigna a line pen, depending on the arguments.
         
         .. py:method:: setLinePen(color, width, style)
+            :noindex:
         
             Build and assign a line pen
     
@@ -548,6 +549,7 @@ def setLinePen(self, *args):
             :param Qt.PenStyle style: Pen style
         
         .. py:method:: setLinePen(pen)
+            :noindex:
         
             Specify a pen for the line.
     
diff --git a/qwt/scale_div.py b/qwt/scale_div.py
@@ -48,22 +48,26 @@ class QwtScaleDiv(object):
         Basic constructor. Lower bound = Upper bound = 0.
 
     .. py:class:: QwtScaleDiv(interval, ticks)
+        :noindex:
     
         :param qwt.interval.QwtInterval interval: Interval
         :param list ticks: list of major, medium and minor ticks
 
     .. py:class:: QwtScaleDiv(lowerBound, upperBound)
+        :noindex:
     
         :param float lowerBound: First boundary
         :param float upperBound: Second boundary
 
     .. py:class:: QwtScaleDiv(lowerBound, upperBound, ticks)
+        :noindex:
     
         :param float lowerBound: First boundary
         :param float upperBound: Second boundary
         :param list ticks: list of major, medium and minor ticks
 
     .. py:class:: QwtScaleDiv(lowerBound, upperBound, minorTicks, mediumTicks, majorTicks)
+        :noindex:
     
         :param float lowerBound: First boundary
         :param float upperBound: Second boundary
@@ -116,11 +120,13 @@ def setInterval(self, *args):
         Change the interval
 
         .. py:method:: setInterval(lowerBound, upperBound)
+            :noindex:
     
             :param float lowerBound: First boundary
             :param float upperBound: Second boundary
 
         .. py:method:: setInterval(interval)
+            :noindex:
     
             :param qwt.interval.QwtInterval interval: Interval
 
diff --git a/qwt/scale_draw.py b/qwt/scale_draw.py
@@ -485,7 +485,7 @@ class QwtScaleDraw(QwtAbstractScaleDraw):
       * `QwtScaleDraw.LeftScale`: The scale is left
       * `QwtScaleDraw.RightScale`: The scale is right
       
-    .. py:class:: QwtAbstractScaleDraw()
+    .. py:class:: QwtScaleDraw()
     
         The range of the scale is initialized to [0, 100],
         The position is at (0, 0) with a length of 100.
@@ -861,11 +861,13 @@ def move(self, *args):
             backbone.
         
         .. py:method:: move(x, y)
+            :noindex:
         
             :param float x: X coordinate
             :param float y: Y coordinate
         
         .. py:method:: move(pos)
+            :noindex:
         
             :param QPointF pos: position
         
diff --git a/qwt/scale_map.py b/qwt/scale_map.py
@@ -35,6 +35,7 @@ class QwtScaleMap(object):
         :param qwt.scale_map.QwtScaleMap other: Other scale map
     
     .. py:class:: QwtScaleMap(p1, p2, s1, s2)
+        :noindex:
     
         Constructor (was provided by `PyQwt` but not by `Qwt`)
         
diff --git a/qwt/scale_widget.py b/qwt/scale_widget.py
@@ -69,6 +69,7 @@ class QwtScaleWidget(QWidget):
         :type parent: QWidget or None
         
     .. py:class:: QwtScaleWidget(align, parent)
+        :noindex:
     
         :param int align: Alignment
         :param QWidget parent: Parent widget
diff --git a/qwt/symbol.py b/qwt/symbol.py
@@ -469,13 +469,15 @@ class QwtSymbol(object):
         :param int style: Symbol Style
             
     .. py:class:: QwtSymbol(style, brush, pen, size)
+        :noindex:
     
         :param int style: Symbol Style
         :param QBrush brush: Brush to fill the interior
         :param QPen pen: Outline pen
         :param QSize size: Size
             
     .. py:class:: QwtSymbol(path, brush, pen)
+        :noindex:
     
         :param QPainterPath path: Painter path
         :param QBrush brush: Brush to fill the interior
@@ -799,11 +801,13 @@ def setSize(self, *args):
         Specify the symbol's size
 
         .. py:method:: setSize(width, [height=-1])
+            :noindex:
         
             :param int width: Width
             :param int height: Height
 
         .. py:method:: setSize(size)
+            :noindex:
         
             :param QSize size: Size
 
@@ -874,6 +878,7 @@ def setPen(self, *args):
         Build and/or assign a pen, depending on the arguments.
         
         .. py:method:: setPen(color, width, style)
+            :noindex:
         
             Build and assign a pen
     
@@ -886,6 +891,7 @@ def setPen(self, *args):
             :param Qt.PenStyle style: Pen style
         
         .. py:method:: setPen(pen)
+            :noindex:
         
             Assign a pen
     
diff --git a/qwt/text.py b/qwt/text.py
diff --git a/scripts/build_doc.bat b/scripts/build_doc.bat
diff --git a/scripts/preview_doc.bat b/scripts/preview_doc.bat

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`.. automodule:: qwt.graphic`
`2`		`- :members:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`.. automodule:: qwt.interval`
`2`		`- :members:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`.. automodule:: qwt.plot_directpainter`
`2`		`- :members:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`.. automodule:: qwt.plot_layout`
`2`		`- :members:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`.. automodule:: qwt.plot_series`
`2`		`- :members:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`.. automodule:: qwt.symbol`
`2`		`- :members:`
-Original file line number
+Diff line change
@@ @@ -1,5 +1 @@ @@
 -Text
 -----
+-
 .. automodule:: qwt.text
 -   :members: