Many fix in doc, correction of warnings when documentation is generated.

Author: Tim-ats-d

doc/source/images/demo.png renamed to doc/source/_static/visual-dialog.png

@@ -55,9 +55,9 @@
     "display_version": True
 }
 
-html_logo = "images/visual-dialog.png"
+html_logo = "_static/visual-dialog.png"
 
-latex_logo = "images/visual-dialog.png"
+latex_logo = "_static/visual-dialog.png"
 
 latex_elements = {
     "pointsize": "12pt"

doc/source/conf.py

@@ -9,7 +9,7 @@ Welcome to Visual-dialog's documentation
 **Visual-dialog** is a **Python library** that allows you to make dialog box in a terminal easily.
 **Visual-dialog** uses ``curses`` to display text in terminals.
 
-.. image:: ./images/demo.png
+.. image:: _static/visual-dialog.png
    :align: center
 
 **Features:**

doc/source/images/demo.gif

@@ -1,14 +1,26 @@
-Text box
-========
+Text boxes
+==========
 
 .. IMPORTANT::
   **Visual-dialog** contains two **modules**: ``visualdialog.box`` and ``visualdialog.dialog``.
   These two **modules** are both imported when you import ``visualdialog``.
 
   Two **classes** are defined in these modules but only ``DialogBox`` is destined to be instantiated.
 
+TextBox
+-------
+
 .. autoclass:: visualdialog.box.TextBox
     :members:
+    :undoc-members:
+    :private-members:
+
+DialogBox
+---------
+
 .. autoclass:: visualdialog.dialog.DialogBox
+    :special-members:
+    :undoc-members:
     :members:
-    :show-inheritance:
+    :private-members:
+

doc/source/index.rst

@@ -84,13 +84,13 @@ class TextBox:
         Dialog box title text attributes. It should be a single curses
         text attribute or a tuple of curses text attribute. This
         defaults to ``curses.A_BOLD``.
-    :type title_text_attr: Optional[Union[CursesTextAttributesConstants,Tuple[CursesTextAttributesConstants],List[CursesTextAttributesConstants]]]
+    :type title_text_attr: Optional[Union[CursesTextAttributesConstants,tuple[CursesTextAttributesConstants],list[CursesTextAttributesConstants]]]
 
     :param downtime_chars:
         List of characters that will trigger a ``downtime_chars_delay``
         time second between the writing of each character.
         This defaults to ``(",", ".", ":", ";", "!", "?")``.
-    :type downtime_chars: Optional[Union[Tuple[str],List[str]]]
+    :type downtime_chars: Optional[Union[tuple[str],list[str]]]
 
     :param downtime_chars_delay:
         Waiting time in seconds after writing a character contained in
@@ -151,7 +151,7 @@ def position(self) -> Tuple[int, int]:
         """Returns a tuple contains x;y position of ``TextBox``.
 
         :returns: x;y position of ``TextBox``.
-        :rtype: Tuple[int, int]
+        :rtype: tuple[int, int]
         """
         return self.text_pos_x - 2, self.text_pos_y - 3
 
@@ -160,7 +160,7 @@ def dimensions(self) -> Tuple[int, int]:
         """Returns a tuple contains dimensions of ``TextBox``.
 
         :returns: Length and width of ``TextBox``.
-        :rtype: Tuple[int, int]
+        :rtype: tuple[int, int]
         """
         return self.length, self.width
 

doc/source/visualdialog.rst

@@ -35,9 +35,6 @@
 
 class DialogBox(TextBox):
     """This class provides methods and attributs to manage a dialog box.
-    
-    Keyword arguments correspond to the instance attributes of ``TextBox``,
-    documented below.
 
     :param end_dialog_indicator: Character that will be displayed in the
         lower right corner the character once all the characters have
@@ -46,6 +43,9 @@ class DialogBox(TextBox):
         to ``"►"``.
     :type end_dialog_indicator: str
 
+    :key kwargs: Keyword arguments correspond to the instance attributes of
+        ``TextBox``.
+
     .. NOTE::
         This class inherits all the methods and attributes of ``TextBox``.
 
@@ -89,7 +89,7 @@ def _display_end_dialog_indicator(
         :param text_attr: Text attributes of
             ``end_dialog_indicator`` method. This defaults to
             ``(curses.A_BOLD, curses.A_BLINK)``.
-        :type text_attr: Optional[Union[Tuple[CursesTextAttributesConstants],List[CursesTextAttributesConstants]]]
+        :type text_attr: Optional[Union[tuple[CursesTextAttributesConstants],list[CursesTextAttributesConstants]]]
         """
         if self.end_dialog_indicator_char:
             with TextAttributes(stdscr, *text_attr):
@@ -134,10 +134,10 @@ def char_by_char(
         :param text_attr: Dialog box curses text attributes. It should
             be a single curses text attribute or a tuple of curses text
             attribute. This defaults an empty tuple.
-        :type text_attr: Optional[Union[CursesTextAttributesConstants,Tuple[CursesTextAttributesConstants],List[CursesTextAttributesConstants]]]
+        :type text_attr: Optional[Union[CursesTextAttributesConstants,tuple[CursesTextAttributesConstants],list[CursesTextAttributesConstants]]]
 
         :param words_attr: This defaults to an empty dictionary.
-        :type words_atttr: Union[Dict[Tuple[str],CursesTextAttributesConstants],Dict[Tuple[str],Tuple[CursesTextAttributesConstants]]]
+        :type words_atttr: Union[Dict[tuple[str],CursesTextAttributesConstants],Dict[tuple[str],tuple[CursesTextAttributesConstants]]]
 
         :param flash_screen: Allows or not to flash screen with a short
             light effect done before writing the first character by
@@ -153,7 +153,7 @@ def char_by_char(
             character in seconds where time waited is a random number
             generated in ``random_delay`` interval. This defaults to
             ``(0, 0)``.
-        :type random_delay: Optional[Tuple[float, flot],List[float, float]]
+        :type random_delay: Optional[tuple[float, flot],list[float, float]]
 
         :param callback: Callable called after writing a character and
             the delay time has elapsed. This defaults to a lambda which
@@ -162,7 +162,7 @@ def char_by_char(
 
         :param cargs: All the arguments that will be passed to callback.
             This defaults to an empty tuple.
-        :type cargs: Optional[Union[Tuple[Any],List[Any]]]
+        :type cargs: Optional[Union[tuple[Any],list[Any]]]
 
         .. NOTE::
             Method flow:
@@ -280,10 +280,10 @@ def word_by_word(
         :param text_attr: Dialog box curses text attributes. It should
             be a single curses text attribute or a tuple of curses text
             attribute. This defaults an empty tuple.
-        :type text_attr: Optional[Union[CursesTextAttributesConstants,Tuple[CursesTextAttributesConstants],List[CursesTextAttributesConstants]]]
+        :type text_attr: Optional[Union[CursesTextAttributesConstants,tuple[CursesTextAttributesConstants],list[CursesTextAttributesConstants]]]
 
         :param words_attr: This defaults to an empty dictionary.
-        :type words_atttr: Union[Dict[Tuple[str],CursesTextAttributesConstants],Dict[Tuple[str],Tuple[CursesTextAttributesConstants]]]
+        :type words_atttr: Union[Dict[tuple[str],CursesTextAttributesConstants],Dict[tuple[str],tuple[CursesTextAttributesConstants]]]
 
         :param cut_char: The delimiter according which to split the text
             in word. This defaults to ``" "``.
@@ -303,7 +303,7 @@ def word_by_word(
             word in seconds where time waited is a random number
             generated in ``random_delay`` interval. This defaults to
             ``(0, 0)``.
-        :type random_delay: Optional[Tuple[float, float],List[float, float]]
+        :type random_delay: Optional[tuple[float, float],list[float, float]]
 
         :param callback: Callable called after writing a word and the
             delay time has elapsed. This defaults to a lambda which do
@@ -312,7 +312,7 @@ def word_by_word(
 
         :param cargs: All the arguments that will be passed to callback.
             This defaults to an empty tuple.
-        :type cargs: Optional[Union[Tuple[Any],List[Any]]]
+        :type cargs: Optional[Union[tuple[Any],list[Any]]]
 
         .. NOTE::
             Method flow:

visualdialog/box.py

@@ -49,7 +49,7 @@ class TextAttributes:
         managed.
 
     :param attributes: List of attributes to activate and desactivate.
-    :type attributes: Union[Tuple[CursesTextAttributesConstants],List[CursesTextAttributesConstants]]
+    :type attributes: Union[tuple[CursesTextAttributesConstants],list[CursesTextAttributesConstants]]
     """
     def __init__(self,
                  stdscr,