made dsi releass ready

Author: Commandcracker

README.md

@@ -1,18 +1,57 @@
 # DSI (Display Server Interactions)
 
 DSI allows you to perform basic interactions on your display server, like screenshotting a window or sending input to it.
-Currently DSI only supports X11/Xorg (GNU/Linux) but it aims to be cross-platform.
+Currently, DSI only supports X11/Xorg (GNU/Linux) but it aims to be cross-platform.
 
-## Usage
+**WARNING: Please Do not use DSI in production, because it's currently in development!**
 
-look at the [documentation]("https://dsi.readthedocs.io/en/latest/) for moor help
+## Quick overview
+
+Look at the [documentation](https://python-dsi.readthedocs.io/en/latest/) for moor information's
+
+### Get a window
 
 ```python
 from dsi import DSI
-
 window = DSI.get_active_window()
+```
+
+### Get basic window information
 
+```python
 print("Active window: ")
 print("\tName: {}".format(window.name))
 print("\tPID: {}".format(window.pid))
 ```
+
+### Take a screenshot of the window
+
+```python
+import cv2
+import numpy as np
+
+img = np.array(window.get_image())
+cv2.imshow(f'Screenshot of "{window.name}"', img)
+
+while True:
+    if cv2.waitKey(1) & 0xFF == ord('q'):
+        break
+```
+
+### Sending keys to a window
+
+```python
+window.send_str("Hello World")
+```
+
+### Sending mouse clicks
+
+```python
+window.send_mouse_click(100, 100)
+```
+
+### Move the mouse pointer
+
+```python
+window.warp_pointer(x=100, y=100)
+```

docs/README.md

@@ -1,6 +1,8 @@
 # DSI Documentation
 
-## Installation/ Requirements
+[DSI's Documentation](https://python-dsi.readthedocs.io/en/latest) is made with [Sphinx](https://www.sphinx-doc.org/en/master/index.html) and it will be automatically uploaded to [Read The Docs](https://readthedocs.org/).
+
+## Installation / Requirements
 
 ```sh
 pip install -Ur requirements.txt
@@ -11,3 +13,7 @@ pip install -Ur requirements.txt
 ```sh
 make html
 ```
+
+## View the build
+
+The view the build you just need to go to [build/html](build/html) and open the [index.html](build/html/index.html) with your web browser

docs/source/conf.py

@@ -50,7 +50,10 @@ def get_version(rel_path: str) -> str:
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx_copybutton"
+    "sphinx_copybutton",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc"
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -77,3 +80,8 @@ def get_version(rel_path: str) -> str:
 html_static_path = ['_static']
 
 intersphinx_mapping = {"python": ("http://docs.python.org/3", None)}
+
+autodoc_default_options = {
+    'member-order': 'bysource',
+    'undoc-members': True,
+}

docs/source/get_window.rst

@@ -1,4 +1,3 @@
-================
 Getting a Window
 ================
 

docs/source/index.rst

@@ -5,8 +5,9 @@ Welcome to DSI's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   get_window
-   os_specific_code
+   get_window.rst
+   os_specific_code.rst
+   reference.rst
 
 Indices and tables
 ==================

docs/source/os_specific_code.rst

@@ -1,4 +1,3 @@
-================
 OS specific code
 ================
 

docs/source/reference.rst

@@ -0,0 +1,10 @@
+Reference
+=========
+
+.. toctree::
+    :maxdepth: 3
+
+    reference/windowbase.rst
+    reference/image.rst
+    reference/base.rst
+    reference/linux.rst

docs/source/reference/base.rst

@@ -0,0 +1,6 @@
+dsi.base.DSIBase
+================
+
+
+.. autoclass:: dsi.base.DSIBase
+    :members:

docs/source/reference/image.rst

@@ -0,0 +1,6 @@
+dsi.image.Image
+===============
+
+
+.. autoclass:: dsi.image.Image
+    :members:

docs/source/reference/linux.rst

@@ -0,0 +1,5 @@
+dsi.linux
+=========
+
+.. automodule:: dsi.linux
+    :members: