Skip to content

Commit 7e7fe31

Browse files
authored
Merge pull request #169 from Integration-Automation/dev
Update docs
2 parents 0a49312 + 8968c9b commit 7e7fe31

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+2994
-2217
lines changed

.idea/AutoControl.iml

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/workspace.xml

Lines changed: 11 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ version: 2
99
build:
1010
os: ubuntu-22.04
1111
tools:
12-
python: "3.11"
12+
python: "3.12"
1313

1414
# Build documentation in the "docs/" directory with Sphinx
1515
sphinx:

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![PyPI](https://img.shields.io/pypi/v/je_auto_control)](https://pypi.org/project/je_auto_control/)
44
[![Python](https://img.shields.io/pypi/pyversions/je_auto_control)](https://pypi.org/project/je_auto_control/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6+
[![Documentation](https://readthedocs.org/projects/autocontrol/badge/?version=latest)](https://autocontrol.readthedocs.io/en/latest/?badge=latest)
67

78
**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).
89

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
sphinx-rtd-theme
1+
sphinx-rtd-theme
2+
sphinx>=7.0

docs/source/API/api_index.rst

Lines changed: 45 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,47 @@
1-
AutoControl API Documentation
2-
----
1+
=================
2+
API Reference
3+
=================
4+
5+
Complete API documentation for all AutoControl modules.
6+
7+
Wrapper API
8+
===========
9+
10+
Platform-agnostic high-level functions.
11+
12+
.. toctree::
13+
:maxdepth: 2
14+
15+
wrapper/mouse
16+
wrapper/keyboard
17+
wrapper/image
18+
wrapper/screen
19+
wrapper/record
20+
21+
Utils API
22+
=========
23+
24+
Utility modules for scripting, reporting, and more.
325

426
.. toctree::
5-
:maxdepth: 4
6-
7-
wrapper/image.rst
8-
wrapper/keyboard.rst
9-
wrapper/mouse.rst
10-
wrapper/record.rst
11-
wrapper/screen.rst
12-
utils/callback.rst
13-
utils/critical_exit.rst
14-
utils/executor.rst
15-
utils/scheduler.rst
16-
utils/file.rst
17-
utils/generate_report.rst
18-
utils/package_manager.rst
19-
utils/socket_server.rst
20-
special/keyboard_keys.rst
21-
special/mouse_keys.rst
27+
:maxdepth: 2
28+
29+
utils/executor
30+
utils/callback
31+
utils/generate_report
32+
utils/scheduler
33+
utils/file
34+
utils/package_manager
35+
utils/socket_server
36+
utils/critical_exit
37+
38+
Key Reference
39+
=============
40+
41+
Platform-specific key code tables.
42+
43+
.. toctree::
44+
:maxdepth: 2
45+
46+
special/keyboard_keys
47+
special/mouse_keys

0 commit comments

Comments
 (0)