minor doc improvements

spyoungtech · spyoungtech · commit 73c815193874 · 2023-05-02T11:16:28.000-07:00
diff --git a/docs/api/async.rst b/docs/api/async.rst
@@ -1,12 +1,28 @@
 Async API
 =========
 
+.. toctree::
+
 The async API is mostly identical to the sync API.
 
-.. autoclass:: ahk._async.engine.AsyncAHK
+AsyncFutureResult
+-----------------
+
+.. autoclass:: ahk._async.transport.AsyncFutureResult
    :members:
    :undoc-members:
 
-.. autoclass:: ahk._async.transport.AsyncFutureResult
+AsyncWindow
+-----------
+
+.. autoclass:: ahk._async.window.AsyncWindow
+   :members:
+   :undoc-members:
+
+
+AsyncAHK
+--------
+
+.. autoclass:: ahk._async.engine.AsyncAHK
    :members:
    :undoc-members:
diff --git a/docs/api/sync.rst b/docs/api/sync.rst
@@ -1,14 +1,32 @@
 Sync API
 ========
 
+.. toctree::
+
+
 The sync API is generated automatically from the async API using ``unasync``.
 
 The sync API is the default API described in most of the README.
 
-.. autoclass:: ahk._sync.engine.AHK
+FutureResult
+------------
+
+.. autoclass:: ahk._sync.transport.FutureResult
    :members:
    :undoc-members:
 
-.. autoclass:: ahk._sync.transport.FutureResult
+
+Window
+------
+
+.. autoclass:: ahk._sync.window.Window
+   :members:
+   :undoc-members:
+
+
+AHK
+---
+
+.. autoclass:: ahk._sync.engine.AHK
    :members:
    :undoc-members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -39,3 +39,5 @@
     'undoc-members': True,
     'special-members': '__init__',
 }
+
+always_document_param_types = True

Original file line number	Diff line number	Diff line change
`@@ -39,3 +39,5 @@`
`39`	`39`	`'undoc-members': True,`
`40`	`40`	`'special-members': '__init__',`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+always_document_param_types = True`