Deploy to GitHub pages

dmwyatt · May 10, 2024 · 0f283b5 · 0f283b5
commit 0f283b5
Show file tree

Hide file tree

Showing 203 changed files with 90,551 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/index.html b/index.html
@@ -0,0 +1,9 @@
+
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0; url='v0.2.0/'" />
+  </head>
+  <body>
+    <p>Redirecting to docs. Click <a href="v0.2.0/">this link</a> if redirect does not happen.
+  </body>
+</html>
diff --git a/main/.buildinfo b/main/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 10beb19649f45f87052fb6dd87ab8c6c
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/main/.doctrees/api.doctree b/main/.doctrees/api.doctree
diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle
diff --git a/main/.doctrees/events.doctree b/main/.doctrees/events.doctree
diff --git a/main/.doctrees/examples.doctree b/main/.doctrees/examples.doctree
diff --git a/main/.doctrees/finding_windows.doctree b/main/.doctrees/finding_windows.doctree
diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree
diff --git a/main/.doctrees/manipulating_windows.doctree b/main/.doctrees/manipulating_windows.doctree
diff --git a/main/_sources/api.rst.txt b/main/_sources/api.rst.txt
@@ -0,0 +1,89 @@
+The API
+=======
+
+Here we document all of the useful parts of the API.
+
+Finding windows
+---------------
+
+See :doc:`finding_windows` for a guide.
+
+.. py:currentmodule:: systa.windows
+
+.. autodata:: current_windows
+
+.. autoclass:: CurrentWindows
+  :members:
+  :special-members: __contains__, __getitem__
+
+.. autoclass:: WindowSearchPredicate
+  :members:
+
+.. autodata:: WindowLookupType
+  :annotation:
+
+.. autoclass:: regex_search
+
+.. autoclass:: classname_search
+
+Controlling windows
+-------------------
+
+.. autoclass:: Window
+  :members:
+  :special-members: __eq__
+
+.. autoclass:: WindowRelativeMouseController
+
+Events
+------
+
+The user's function will be called with one argument whose value is an instance of the
+``EventData`` :func:`~dataclasses.dataclass`.
+
+``listen_to`` decorators
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. py:currentmodule:: systa.events.decorators.listen_to
+
+.. automodule:: systa.events.decorators.listen_to
+  :members:
+
+``filter_by`` decorators
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: systa.events.decorators.filter_by
+  :members:
+
+Event types
+^^^^^^^^^^^
+
+.. autoclass:: systa.events.types.EventData
+  :members:
+
+.. autoclass:: systa.events.types.CallbackReturn
+  :members:
+
+.. autodata:: systa.events.types.EventType
+  :annotation:
+
+Other types
+-----------
+
+.. py:currentmodule:: systa.types
+
+.. autoclass:: systa.types.Point
+  :members:
+  :special-members: __iter__
+
+.. autoclass:: systa.types.Rect
+  :members:
+  :special-members: __iter__
+
+Helpers
+-------
+
+.. automodule:: systa.backend.monitors
+   :members:
+
+.. autofunction:: systa.utils.composed