Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .idea/AutoControl.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 11 additions & 7 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
python: "3.12"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![PyPI](https://img.shields.io/pypi/v/je_auto_control)](https://pypi.org/project/je_auto_control/)
[![Python](https://img.shields.io/pypi/pyversions/je_auto_control)](https://pypi.org/project/je_auto_control/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Documentation](https://readthedocs.org/projects/autocontrol/badge/?version=latest)](https://autocontrol.readthedocs.io/en/latest/?badge=latest)

**AutoControl** is a cross-platform Python GUI automation framework providing mouse control, keyboard input, image recognition, screen capture, action scripting, and report generation — all through a unified API that works on Windows, macOS, and Linux (X11).

Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
sphinx-rtd-theme
sphinx-rtd-theme
sphinx>=7.0
64 changes: 45 additions & 19 deletions docs/source/API/api_index.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,47 @@
AutoControl API Documentation
----
=================
API Reference
=================

Complete API documentation for all AutoControl modules.

Wrapper API
===========

Platform-agnostic high-level functions.

.. toctree::
:maxdepth: 2

wrapper/mouse
wrapper/keyboard
wrapper/image
wrapper/screen
wrapper/record

Utils API
=========

Utility modules for scripting, reporting, and more.

.. toctree::
:maxdepth: 4

wrapper/image.rst
wrapper/keyboard.rst
wrapper/mouse.rst
wrapper/record.rst
wrapper/screen.rst
utils/callback.rst
utils/critical_exit.rst
utils/executor.rst
utils/scheduler.rst
utils/file.rst
utils/generate_report.rst
utils/package_manager.rst
utils/socket_server.rst
special/keyboard_keys.rst
special/mouse_keys.rst
:maxdepth: 2

utils/executor
utils/callback
utils/generate_report
utils/scheduler
utils/file
utils/package_manager
utils/socket_server
utils/critical_exit

Key Reference
=============

Platform-specific key code tables.

.. toctree::
:maxdepth: 2

special/keyboard_keys
special/mouse_keys
Loading
Loading