summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorIan Ward <ian@excess.org>2012-07-14 21:13:24 -0400
committerIan Ward <ian@excess.org>2012-07-14 21:13:24 -0400
commitf4c0a6c76b8a51d12705e0e62310f3329a4cc6fd (patch)
tree75e47400cd2b1f8a3da1fb6cc0bdd39644500ceb /docs/reference
parentc0869e9ead7f282a00a2d82831dc431a716ac0ca (diff)
downloadurwid-f4c0a6c76b8a51d12705e0e62310f3329a4cc6fd.tar.gz
More headings to make important classes easier to find
--HG-- branch : feature-sphinx
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/main_loop.rst19
-rw-r--r--docs/reference/widget.rst50
2 files changed, 66 insertions, 3 deletions
diff --git a/docs/reference/main_loop.rst b/docs/reference/main_loop.rst
index c9519f9..97c9207 100644
--- a/docs/reference/main_loop.rst
+++ b/docs/reference/main_loop.rst
@@ -1,13 +1,28 @@
-Main Loops and Event Loops
-==========================
+MainLoop and Event Loops
+========================
.. currentmodule:: urwid
+MainLoop
+--------
+
.. autoclass:: MainLoop
+Event Loops
+-----------
+
+SelectEventLoop
+~~~~~~~~~~~~~~~
+
.. autoclass:: SelectEventLoop
+GLibEventLoop
+~~~~~~~~~~~~~
+
.. autoclass:: GLibEventLoop
+TwistedEventLoop
+~~~~~~~~~~~~~~~~
+
.. autoclass:: TwistedEventLoop
diff --git a/docs/reference/widget.rst b/docs/reference/widget.rst
index 8a05d68..eb11186 100644
--- a/docs/reference/widget.rst
+++ b/docs/reference/widget.rst
@@ -6,43 +6,91 @@ Widget Classes
Widget Base Class
-----------------
+Widget
+~~~~~~
+
.. autoclass:: Widget
Basic Widgets
-------------
+Text
+~~~~
+
.. autoclass:: Text
+Edit
+~~~~
+
.. autoclass:: Edit
-Decotation Widgets
+Decoration Widgets
------------------
+AttrMap
+~~~~~~~
+
.. autoclass:: AttrMap
+Padding
+~~~~~~~
+
.. autoclass:: Padding
+Filler
+~~~~~~
+
.. autoclass:: Filler
+Divider
+~~~~~~~
+
.. autoclass:: Divider
+LineBox
+~~~~~~~
+
.. autoclass:: LineBox
+SolidFill
+~~~~~~~~~
+
.. autoclass:: SolidFill
Container Widgets
-----------------
+Frame
+~~~~~
+
.. autoclass:: Frame
+ListBox
+~~~~~~~
+
.. autoclass:: ListBox
+Columns
+~~~~~~~
+
.. autoclass:: Columns
+Pile
+~~~~
+
.. autoclass:: Pile
+GridFlow
+~~~~~~~~
+
.. autoclass:: GridFlow
+BoxAdapter
+~~~~~~~~~~
+
.. autoclass:: BoxAdapter
+Overlay
+~~~~~~~
+
.. autoclass:: Overlay