Added missing doc (rotatecrop, ...)

Author: PierreRaybaut

doc/features/fliprotate.rst

@@ -0,0 +1 @@
+.. automodule:: plotpy.widgets.fliprotate

doc/features/imagefile.rst

@@ -0,0 +1 @@
+.. automodule:: plotpy.widgets.imagefile

doc/features/index.rst

@@ -49,7 +49,11 @@ Plot widgets with integrated plot manager:
    panels/index
    fit
    pyplot
+   resizedialog
+   rotatecrop
+   fliprotate
    selectdialog
+   imagefile
    io
    signals
    mathutils/index

doc/features/items/reference.rst

@@ -78,6 +78,8 @@ Grid
 Shapes
 ^^^^^^
 
+.. autoclass:: plotpy.items.AbstractShape
+   :members:
 .. autoclass:: plotpy.items.PolygonShape
    :members:
 .. autoclass:: plotpy.items.RectangleShape

doc/features/resizedialog.rst

@@ -0,0 +1 @@
+.. automodule:: plotpy.widgets.resizedialog

doc/features/rotatecrop.rst

@@ -0,0 +1 @@
+.. automodule:: plotpy.widgets.rotatecrop

doc/features/tools/overview.rst

@@ -37,6 +37,7 @@ The `tools` module provides the following tools:
 * :py:class:`.tools.MultiLineTool`
 * :py:class:`.tools.FreeFormTool`
 * :py:class:`.tools.LabelTool`
+* :py:class:`.tools.RectangularShapeTool`
 * :py:class:`.tools.RectangleTool`
 * :py:class:`.tools.PointTool`
 * :py:class:`.tools.SegmentTool`

doc/features/tools/reference.rst

@@ -23,6 +23,8 @@ Reference
    :members:
 .. autoclass:: plotpy.tools.LabelTool
    :members:
+.. autoclass:: plotpy.tools.RectangularShapeTool
+   :members:
 .. autoclass:: plotpy.tools.RectangleTool
    :members:
 .. autoclass:: plotpy.tools.PointTool

doc/requirements.rst

@@ -9,7 +9,7 @@ The :mod:`plotpy` package requires the following Python modules:
       - Summary
     * - Python
       - >=3.8, <4
-      -
+      - 
     * - guidata
       - >=3.1
       - Automatic GUI generation for easy dataset editing and display
@@ -23,10 +23,10 @@ The :mod:`plotpy` package requires the following Python modules:
       - >=1.3
       - Fundamental algorithms for scientific computing in Python
     * - Pillow
-      -
+      - 
       - Python Imaging Library (Fork)
     * - tifffile
-      -
+      - 
       - Read and write TIFF files
     * - PyQt5
       - >=5.11
@@ -42,19 +42,19 @@ Optional modules for development:
       - Version
       - Summary
     * - black
-      -
+      - 
       - The uncompromising code formatter.
     * - isort
-      -
+      - 
       - A Python utility / library to sort Python imports.
     * - pylint
-      -
+      - 
       - python code static checker
     * - Coverage
-      -
+      - 
       - Code coverage measurement for Python
     * - Cython
-      -
+      - 
       - The Cython compiler for writing C extensions in the Python language.
 
 Optional modules for building the documentation:
@@ -67,19 +67,19 @@ Optional modules for building the documentation:
       - Version
       - Summary
     * - PyQt5
-      -
+      - 
       - Python bindings for the Qt cross platform application toolkit
     * - sphinx
-      -
+      - 
       - Python documentation generator
     * - sphinx-copybutton
-      -
+      - 
       - Add a copy button to each of your code cells.
     * - sphinx_qt_documentation
-      -
+      - 
       - Plugin for proper resolve intersphinx references for Qt elements
     * - python-docs-theme
-      -
+      - 
       - The Sphinx theme for the CPython docs and related projects
 
 Optional modules for running test suite:
@@ -92,14 +92,14 @@ Optional modules for running test suite:
       - Version
       - Summary
     * - pytest
-      -
+      - 
       - pytest: simple powerful testing with Python
     * - pytest-cov
-      -
+      - 
       - Pytest plugin for measuring coverage.
     * - pytest-qt
-      -
+      - 
       - pytest support for PyQt and PySide applications
     * - pytest-xvfb
-      -
+      - 
       - A pytest plugin to run Xvfb (or Xephyr/Xvnc) for tests.

plotpy/items/shapes/base.py

@@ -15,6 +15,7 @@
 
 if TYPE_CHECKING:  # pragma: no cover
     from qtpy import QtCore as QC
+    from qtpy.QtCore import QPointF  # helping out python_qt_documentation
 
     from plotpy.interfaces import IItemType
     from plotpy.styles.base import ItemParameters
@@ -163,7 +164,7 @@ def unselect(self) -> None:
         self.selected = False
         self.invalidate_plot()
 
-    def hit_test(self, pos: QC.QPointF) -> tuple[float, float, bool, None]:
+    def hit_test(self, pos: QPointF) -> tuple[float, float, bool, None]:
         """Return a tuple (distance, attach point, inside, other_object)
 
         Args:
@@ -208,7 +209,7 @@ def set_item_parameters(self, itemparams):
         pass
 
     def move_local_point_to(
-        self, handle: int, pos: QC.QPointF, ctrl: bool = False
+        self, handle: int, pos: QPointF, ctrl: bool = False
     ) -> None:
         """Move a handle as returned by hit_test to the new position
 
@@ -224,7 +225,7 @@ def move_local_point_to(
         if self.plot():
             self.plot().SIG_ITEM_HANDLE_MOVED.emit(self)
 
-    def move_local_shape(self, old_pos: QC.QPointF, new_pos: QC.QPointF) -> None:
+    def move_local_shape(self, old_pos: QPointF, new_pos: QPointF) -> None:
         """Translate the shape such that old_pos becomes new_pos in canvas coordinates
 
         Args:
@@ -259,7 +260,7 @@ def move_point_to(
         """
         pass
 
-    def move_shape(self, old_pos: QC.QPointF, new_pos: QC.QPointF) -> None:
+    def move_shape(self, old_pos: QPointF, new_pos: QPointF) -> None:
         """Translate the shape such that old_pos becomes new_pos in axis coordinates
 
         Args: