Visual-dialog 0.9

Author: Tim-ats-d

CONTRIBUTING.md

@@ -49,9 +49,6 @@ This tree does not contain a description of all the files in the repository, onl
 │   ├── source/
 │   │   Contains images used in documentation.
 │   │   │
-│   │   ├── images/
-│   │   │   Contains images used in documentation.
-│   │   │
 │   │   ├── conf.py
 │   │   │   Sphinx's configuration file.
 │   │   │
@@ -79,10 +76,16 @@ This tree does not contain a description of all the files in the repository, onl
 │   ├── __init__.py
 │   │
 │   ├── box.py
-│   │   Contains the parent class TextBox which serves as a basis for the implementation of the other classes.
+│   │   Contains the parent class BaseTextBox which serves as a basis for the implementation of the other classes.
 │   │
 │   ├── dialog.py
-│   │   Contains the DialogBox class, which is the main class of the library.
+│   │   Contains DialogBox class, which is the main class provides by the library.
+│   │
+│   ├── error.py
+│   │   Contains exceptions raised by the library.
+│   │
+│   ├── type.py
+│   │   Contains custom type hinting used by the library.
 │   │
 │   └── utils.py
 │       Contains the classes and functions used but not related to the libriarie.

LICENSE

@@ -69,7 +69,7 @@ pip install sphinx sphinx_rtd_theme
 
 ### Hello world with **Visual-dialog**
 
-```python3
+```py3
 import curses
 
 from visualdialog import DialogBox
@@ -84,8 +84,8 @@ def main(win):
     textbox = DialogBox(x, y,
                         height, width,
                         title="Demo")
-    textbox.char_by_char(win,
-                         "Hello world")
+    textbox.char_by_char("Hello world",
+                         win)
 
 
 curses.wrapper(main)
@@ -126,8 +126,7 @@ You can also help by reporting **bugs**.
 
 ## License
 
-Distributed under the **GPL-2.0 License**. See [license](LICENSE) for more information.
-
+Distributed under the **LGPL-3.0 License**. See [license](LICENSE) for more information.
 
 ## Acknowledgements
 

README.md

@@ -5,4 +5,5 @@ API documentation
   :maxdepth: 2
 
   visualdialog.rst
+  error.rst
   utils.rst

doc/source/api.rst

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

doc/source/conf.py

@@ -0,0 +1,8 @@
+Exceptions
+==========
+
+**Visual-dialog** defined several exceptions raised by library. 
+
+.. autoexception:: visualdialog.error.ValueNotInBound
+
+.. autoexception:: visualdialog.error.PanicError

doc/source/error.rst

@@ -18,5 +18,5 @@ You can use this behavior to perform multiple tasks while text scrolling.
 I am not satisfied with the behavior of DialogBox, how can I change it?
 -----------------------------------------------------------------------
 
-You can create your own derived class by inheriting from ``BaseTextBox``.
-Additionally, you can override the methods of ``DialogBox``.
+You can create your own derived class by inheriting from :class:`BaseTextBox`.
+Additionally, you can override the methods of :class:`DialogBox`.

doc/source/faq.rst

@@ -20,7 +20,7 @@ Welcome to Visual-dialog's documentation
 - Text coloring and formatting.
 - Hackable and configurable.
 
-.. IMPORTANT::
+.. important::
    I recommend that you have some knowledge of Python ``curses`` module in order to use the library to its full potential.
 
    Here several links to learn ``curses``:
@@ -32,7 +32,7 @@ Getting started
 ---------------
 
 - **First steps:**
-- **Examples:** Many examples are available in the `repository <https://github.com/Tim-ats-d/Visual-dialog/issues>`_.
+- **Examples:** Many examples are available in the `repository <https://github.com/Tim-ats-d/Visual-dialog/tree/main/examples>`_.
 
 Getting help
 ------------

doc/source/index.rst

@@ -6,12 +6,22 @@ Using PIP
 
 Install **Visual-dialog** using ``pip`` (The lib is not yet available on **pypi**):
 
-.. code-block::
+.. code-block:: text
 
   pip install git+git://github.com/Tim-ats-d/Visual-dialog
 
 or update library to the latest version:
 
-.. code-block::
+.. code-block:: text
 
   pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
+
+From source
+-----------
+
+.. code-block:: text
+
+  git clone https://github.com/Tim-ats-d/Visual-dialog.git
+  cd Visual-dialog
+  pip install .
+

doc/source/installation.rst

@@ -12,9 +12,9 @@ Curses
 **Visual-dialog** works with ``curses`` Python module.
 It is available in the standard **Python** library on **UNIX** but it doesn't work out-of-the-box on **Windows**.
 
-To install ``curses`` on **Windows**, you need ``windows-curses`` module:
+To install ``curses`` on **Windows**, you need `windows-curses <https://pypi.org/project/windows-curses/>`_ module:
 
-.. code-block::
+.. code-block:: text
 
   pip install curses-windows
 
@@ -24,6 +24,6 @@ To build the documentation
 - `Sphinx <https://www.sphinx-doc.org/en/master/usage/installation.html>`_ to generate the documentation of library.
 - `sphinx-rtd-theme <https://pypi.org/project/sphinx-rtd-theme/>`_ used as documentation theme.
 
-.. code-block::
+.. code-block:: text
 
   pip install sphinx sphinx_rtd_theme