Improve docs

Author: ppizarror

docs/_source/add_sounds.rst

@@ -24,9 +24,9 @@ can be customized by setting a sound file to several sounds defined by a type.
 
 Sound types are the following:
 
-========================================================  =============================
+========================================================  =========================
 Type                                                      Description
-========================================================  =============================
+========================================================  =========================
 :py:data:`pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE`       Mouse click
 :py:data:`pygame_menu.sound.SOUND_TYPE_CLOSE_MENU`        A menu is closed
 :py:data:`pygame_menu.sound.SOUND_TYPE_ERROR`             Generic error
@@ -36,7 +36,7 @@ Type                                                      Description
 :py:data:`pygame_menu.sound.SOUND_TYPE_KEY_DELETION`      User deletes with a key
 :py:data:`pygame_menu.sound.SOUND_TYPE_OPEN_MENU`         A menu is opened
 :py:data:`pygame_menu.sound.SOUND_TYPE_WIDGET_SELECTION`  A widget is selected
-========================================================  =============================
+========================================================  =========================
 
 .. autoclass:: Sound
     :members:

docs/_source/add_widgets.rst

@@ -15,8 +15,8 @@ Add a button
 A button is a text that fire action when the user trigger it. An action is linked
 to a button by defining the ``action`` parameter with one of the three values:
 
- - a :py:class:`pygame_menu.menu.Menu`, in this case, it will be displayed
-   when the button is triggered.
+ - a :py:class:`pygame_menu.menu.Menu`, in this case, it will be displayed when
+   the button is triggered.
  - a python callable object (a function, a method, a class, ...) that will be
    called with the given arguments.
  - a specific event of :py:mod:`pygame_menu`. The possible events are the

docs/_source/advanced_selection.rst

@@ -1,11 +1,11 @@
 
 :orphan:
 
-================
-Widget Selection
-================
+========================
+Widget selection effects
+========================
 
-Selection Effect
+Core Class
 ----------------
 
 .. module:: pygame_menu.widgets.core.selection
@@ -14,8 +14,8 @@ Selection Effect
     :members:
 
 
-Highlight Selection Effect
---------------------------
+Highlight Selection
+-------------------
 
 .. module:: pygame_menu.widgets.selection.highlight
 
@@ -24,8 +24,8 @@ Highlight Selection Effect
     :show-inheritance:
 
 
-Left Arrow Selection Effect
----------------------------
+Left Arrow Selection
+--------------------
 
 .. module:: pygame_menu.widgets.selection.left_arrow
 
@@ -34,8 +34,8 @@ Left Arrow Selection Effect
     :show-inheritance:
 
 
-None Selection Effect
----------------------
+None Selection
+--------------
 
 .. module:: pygame_menu.widgets.selection.none
 
@@ -44,12 +44,21 @@ None Selection Effect
     :show-inheritance:
 
 
-Right Arrow Selection Effect
-----------------------------
+Right Arrow Selection
+---------------------
 
 .. module:: pygame_menu.widgets.selection.right_arrow
 
 .. autoclass:: pygame_menu.widgets.RightArrowSelection
     :members:
     :show-inheritance:
-    
+
+
+Simple Selection
+----------------
+
+.. module:: pygame_menu.widgets.selection.simple
+
+.. autoclass:: pygame_menu.widgets.SimpleSelection
+    :members:
+    :show-inheritance:

docs/_source/themes.rst

@@ -70,13 +70,13 @@ Alignment
 
 The alignment (str) can take one of the three following values:
 
-==============================================  ========================
+==============================================  ==================
 Alignment                                       Description
-==============================================  ========================
+==============================================  ==================
 :py:data:`pygame_menu.locals.ALIGN_LEFT`        Left alignment
 :py:data:`pygame_menu.locals.ALIGN_CENTER`      Center alignment
 :py:data:`pygame_menu.locals.ALIGN_RIGHT`       Right alignment
-==============================================  ========================
+==============================================  ==================
 
 
 Background Color/Images
@@ -106,16 +106,16 @@ Images needs a Path (file location on disk), a drawing mode, and an optional off
     )
     mytheme.background_color = myimage
 
-=====================================================   =========================================
+=====================================================   ======================================
 Image drawing modes                                     Description
-=====================================================   =========================================
+=====================================================   ======================================
 :py:data:`pygame_menu.baseimage.IMAGE_MODE_CENTER`      Centers the image in the surface
 :py:data:`pygame_menu.baseimage.IMAGE_MODE_FILL`        Fill the image on the surface
 :py:data:`pygame_menu.baseimage.IMAGE_MODE_REPEAT_X`    Repeat the image on x axis
 :py:data:`pygame_menu.baseimage.IMAGE_MODE_REPEAT_XY`   Repeat the image on x and y axis
 :py:data:`pygame_menu.baseimage.IMAGE_MODE_REPEAT_Y`    Repeat the image on y axis
 :py:data:`pygame_menu.baseimage.IMAGE_MODE_SIMPLE`      Write the image on top-left location
-=====================================================   =========================================
+=====================================================   ======================================
 
 Currently, :py:class:`Theme` class only supports images for :py:attr:`background_color`
 and :py:attr:`widget_background_color`. Also, only `IMAGE_MODE_FILL` drawing mode
@@ -185,9 +185,9 @@ Positioning
 
 Several possible positions are accepted by some configurations:
 
-=================================================  ========================
+=================================================  =====================
 Position                                           Description
-=================================================  ========================
+=================================================  =====================
 :py:data:`pygame_menu.locals.POSITION_EAST`        East position
 :py:data:`pygame_menu.locals.POSITION_NORTH`       North position
 :py:data:`pygame_menu.locals.POSITION_NORTHEAST`   North/East position
@@ -196,7 +196,7 @@ Position                                           Description
 :py:data:`pygame_menu.locals.POSITION_SOUTHEAST`   South/East position
 :py:data:`pygame_menu.locals.POSITION_SOUTHWEST`   South/West position
 :py:data:`pygame_menu.locals.POSITION_WEST`        West position
-=================================================  ========================
+=================================================  =====================
 
 Special positions used by Menu :py:class:`pygame_menu._scrollarea.ScrollArea`
 (all above are available):

docs/index.rst

@@ -94,19 +94,20 @@ This chapter define rules and advanced tips and tricks to develop extensions for
 - :ref:`Creating a selection effect <Create a selection effect>`
 
 .. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: Advanced usage
+    :maxdepth: 2
+    :hidden:
+    :caption: Advanced usage
 
-   _source/advanced
+    _source/advanced
+    _source/advanced_selection
 
 .. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: Menu APIs
+    :maxdepth: 2
+    :hidden:
+    :caption: Menu APIs
 
-   _source/baseimage
-   _source/scrollarea.rst
+    _source/baseimage
+    _source/scrollarea.rst
 
 
 ===========

pygame_menu/widgets/selection/arrow_selection.py

@@ -47,13 +47,13 @@ class ArrowSelection(Selection):
     Widget selection arrow class.
     Parent class for left and right arrow selection classes.
 
-    :param margin_left: Left margin
-    :param margin_right: Right margin
-    :param margin_top: Top margin
-    :param margin_bottom: Bottom margin
+    :param margin_left: Left margin (px)
+    :param margin_right: Right margin (px)
+    :param margin_top: Top margin (px)
+    :param margin_bottom: Bottom margin (px)
     :param arrow_size: Size of arrow on x-axis and y-axis (width, height) in px
-    :param arrow_vertical_offset: Vertical offset of the arrow
-    :param blink_ms: Milliseconds between each blink, if ``0`` blinking is disabled
+    :param arrow_vertical_offset: Vertical offset of the arrow (px)
+    :param blink_ms: Milliseconds between each blink; if ``0`` blinking is disabled
     """
     _arrow_vertical_offset: int
     _arrow_size: Tuple2IntType

pygame_menu/widgets/selection/highlight.py

@@ -47,9 +47,9 @@ class HighlightSelection(Selection):
 
         Widget background color may not reach the entire selection area.
 
-    :param border_width: Border width of the highlight box
-    :param margin_x: X margin of selected highlight box
-    :param margin_y: Y margin of selected highlight box
+    :param border_width: Border width of the highlight box (px)
+    :param margin_x: X margin of selected highlight box (px)
+    :param margin_y: Y margin of selected highlight box (px)
     """
     _border_width: int
 

pygame_menu/widgets/selection/left_arrow.py

@@ -45,9 +45,9 @@ class LeftArrowSelection(ArrowSelection):
     Creates an arrow to the left of the selected Menu item.
 
     :param arrow_size: Size of arrow on x-axis and y-axis (width, height) in px
-    :param arrow_right_margin: Distance from the arrow to the widget
-    :param arrow_vertical_offset: Vertical offset of the arrow
-    :param blink_ms: Milliseconds between each blink, if ``0`` blinking is disabled
+    :param arrow_right_margin: Distance from the arrow to the widget (px)
+    :param arrow_vertical_offset: Vertical offset of the arrow (px)
+    :param blink_ms: Milliseconds between each blink; if ``0`` blinking is disabled
     """
     _arrow_right_margin: int
 

pygame_menu/widgets/selection/right_arrow.py

@@ -45,9 +45,9 @@ class RightArrowSelection(ArrowSelection):
     selected Menu item.
 
     :param arrow_size: Size of arrow on x-axis and y-axis (width, height) in px
-    :param arrow_left_margin: Distance from the arrow to the widget
-    :param arrow_vertical_offset: Vertical offset of the arrow
-    :param blink_ms: Milliseconds between each blink, if ``0`` blinking is disabled
+    :param arrow_left_margin: Distance from the arrow to the widget (px)
+    :param arrow_vertical_offset: Vertical offset of the arrow (px)
+    :param blink_ms: Milliseconds between each blink; if ``0`` blinking is disabled
     """
     _arrow_left_margin: int
 

pygame_menu/widgets/widget/scrollbar.py

@@ -69,7 +69,7 @@ class ScrollBar(Widget):
     :param values_range: Min and max values
     :param scrollbar_id: Bar identifier
     :param orientation: Bar orientation (horizontal or vertical). See :py:mod:`pygame_menu.locals`
-    :param slider_pad: Space between slider and page control
+    :param slider_pad: Space between slider and page control (px)
     :param slider_color: Color of the slider
     :param page_ctrl_thick: Page control thickness
     :param page_ctrl_color: Page control color