Updated documentation

Author: Kalmat

README.md

@@ -1,13 +1,16 @@
 # EWMHlib
-[![CI](https://github.com/Kalmat/EWMHlib/actions/workflows/ci.yml/badge.svg)](https://github.com/Kalmat/EWMHlib/actions/workflows/ci.yml)
-[![PyPI version](https://badge.fury.io/py/ewmhlib.svg)](https://badge.fury.io/py/ewmhlib)
+[![CI](https://github.com/Kalmat/EWMHlib/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Kalmat/EWMHlib/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/EWMHlib.svg)](https://badge.fury.io/py/EWMHlib)
 [![Documentation Status](https://readthedocs.org/projects/ewmhlib/badge/?version=latest)](https://ewmhlib.readthedocs.io/en/latest/?badge=latest)
+[![Downloads](https://static.pepy.tech/badge/ewmhlib/month)](https://pepy.tech/project/ewmhlib)
+[![Stars](https://img.shields.io/github/stars/Kalmat/EWMHlib?style=flat)](https://github.com/Kalmat/EWMHlib/stargazers)
+[![License](https://img.shields.io/badge/license-BSD%203--Clause-blue)](LICENSE.txt)
 
 A complete [EWMH](https://specifications.freedesktop.org/wm-spec/latest/) (Extended Window Manager Hints) implementation in Python 3 and python-xlib. Provides full, Pythonic access to the EWMH spec — query and control any compliant Window Manager, manage window hints, and subscribe to X events.
 
 **Tested on:** Ubuntu/GNOME · Mint/Cinnamon · Manjaro/KDE · Raspbian/LXDE
 
-> **⚠️ Wayland note:** The new protocol used by GNOME in Ubuntu (Wayland) is not EWMH-compliant. Many features will not work under Wayland.
+> **⚠️ Wayland note:** The new protocol used by GNOME in Ubuntu (Wayland) is not EWMH-compliant. This module is likely not working under Wayland.
 
 ---
 

docs/source/conf.py

@@ -42,11 +42,18 @@
 
 # -- Copy the modules documentation ------------------------------------------
 # https://stackoverflow.com/questions/66495200/is-it-possible-to-include-external-rst-files-in-my-documentation
+from urllib.request import urlretrieve
+import os
+
 urlretrieve(
     "https://raw.githubusercontent.com/kalmat/ewmhlib/master/README.md",
     "index.md"
 )
+
+os.mkdir("docs")
+os.chdir("docs")
 urlretrieve(
     "https://raw.githubusercontent.com/kalmat/ewmhlib/master/docs/docstrings.md",
     "docstrings.md"
 )
+os.chdir("..")

tests/test_ewmhlib.py

@@ -1,18 +1,16 @@
-import sys
 import time
 
 import Xlib.protocol
 import Xlib.X
 
-sys.path.insert(0, "../src/")
-from ewmhlib import Props, getDisplaysInfo, EwmhRoot, EwmhWindow
+import ewmhlib
 
 
 def main() -> None:
     print("ALL DISPLAYS")
-    print(getDisplaysInfo())
+    print(ewmhlib.getDisplaysInfo())
 
-    root = EwmhRoot()
+    root = ewmhlib.EwmhRoot()
 
     print("DESKTOP LAYOUT")
     print(root.getDesktopLayout())
@@ -55,7 +53,7 @@ def main() -> None:
     if w:
         print("REQ FRAME EXTENTS")
         print(root.requestFrameExtents(w))
-        win = EwmhWindow(w)
+        win = ewmhlib.EwmhWindow(w)
         name = win.getName()
         print("NAME", name)
         visName = win.getVisibleName()
@@ -94,16 +92,16 @@ def callback(event: Xlib.protocol.rq.Event):
         print("MOVING/RESIZING")
         root.setMoveResize(w, x=100, y=100, width=800, height=600, userAction=True)  # Equivalent to win.setMoveResize()
         print("BELOW ON")
-        win.changeWmState(Props.StateAction.ADD, Props.State.BELOW)
+        win.changeWmState(ewmhlib.Props.StateAction.ADD, ewmhlib.Props.State.BELOW)
         time.sleep(4)
         print("BELOW OFF")
-        win.changeWmState(Props.StateAction.REMOVE, Props.State.BELOW)
+        win.changeWmState(ewmhlib.Props.StateAction.REMOVE, ewmhlib.Props.State.BELOW)
         time.sleep(4)
         print("DESKTOP")
-        win.setWmWindowType(Props.WindowType.DESKTOP)
+        win.setWmWindowType(ewmhlib.Props.WindowType.DESKTOP)
         time.sleep(4)
         print("NORMAL")
-        win.setWmWindowType(Props.WindowType.NORMAL)
+        win.setWmWindowType(ewmhlib.Props.WindowType.NORMAL)
         print("MAX HORZ ON")
         win.setMaximized(True, False)
         time.sleep(4)