diff options
| author | Ian Ward <ian@excess.org> | 2012-05-21 21:47:15 -0400 |
|---|---|---|
| committer | Ian Ward <ian@excess.org> | 2012-05-21 21:47:15 -0400 |
| commit | ef2e6aebea204fa4dcfaa27daaa31bdc942fbc10 (patch) | |
| tree | 31c25f53bb5f7dd3e570bb1f70c5a9f51f226fa1 /docs | |
| parent | ee335f8388624f2b9c920f850e12428bc5e65c05 (diff) | |
| parent | 799c23dd22b62cdcceae9648dd169b71eadcc7ca (diff) | |
| download | urwid-ef2e6aebea204fa4dcfaa27daaa31bdc942fbc10.tar.gz | |
Merge pazz/sphinx
--HG--
branch : feature-sphinx
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/decorations.rst | 16 | ||||
| -rw-r--r-- | docs/reference/exceptions.rst | 6 | ||||
| -rw-r--r-- | docs/reference/index.rst | 3 | ||||
| -rw-r--r-- | docs/reference/main_loop.rst | 20 | ||||
| -rw-r--r-- | docs/reference/widget.rst | 19 |
5 files changed, 31 insertions, 33 deletions
diff --git a/docs/reference/decorations.rst b/docs/reference/decorations.rst new file mode 100644 index 0000000..afbdf41 --- /dev/null +++ b/docs/reference/decorations.rst @@ -0,0 +1,16 @@ +Decorations +=========== + +.. module:: urwid + +.. autoclass:: AttrMap + +.. autoclass:: Padding + +.. autoclass:: Filler + +.. autoclass:: Divider + +.. autoclass:: LineBox + +.. autoclass:: SolidFill diff --git a/docs/reference/exceptions.rst b/docs/reference/exceptions.rst new file mode 100644 index 0000000..26cba80 --- /dev/null +++ b/docs/reference/exceptions.rst @@ -0,0 +1,6 @@ +Exceptions +========== + +.. autoexception:: urwid.ExitMainLoop + +.. autoexception:: urwid.WidgetError diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 927f555..74f3669 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,6 +6,7 @@ Urwid Reference main_loop widget - basic + decorations constants listbox + exceptions diff --git a/docs/reference/main_loop.rst b/docs/reference/main_loop.rst index 73695c7..78fc0b3 100644 --- a/docs/reference/main_loop.rst +++ b/docs/reference/main_loop.rst @@ -1,19 +1,13 @@ -Main Loop and Event Loop Classes -================================ +Main Loops and Event Loops +========================== -Main Loop ---------- +.. module:: urwid -.. autoexception:: urwid.ExitMainLoop +.. autoclass:: MainLoop -.. autoclass:: urwid.MainLoop +.. autoclass:: SelectEventLoop -Event Loops ------------ +.. autoclass:: GLibEventLoop -.. autoclass:: urwid.SelectEventLoop - -.. autoclass:: urwid.GLibEventLoop - -.. autoclass:: urwid.TwistedEventLoop +.. autoclass:: TwistedEventLoop diff --git a/docs/reference/widget.rst b/docs/reference/widget.rst index 42227cf..4de6bf5 100644 --- a/docs/reference/widget.rst +++ b/docs/reference/widget.rst @@ -1,25 +1,6 @@ Widget Base Class ================= -Widget and Related Classes --------------------------- - .. autoclass:: urwid.Widget - :private-members: - :members: .. autoclass:: urwid.WidgetMeta - -.. autoexception:: urwid.WidgetError - - -Deprecated Base Classes ------------------------ - -.. autoclass:: urwid.FlowWidget - -.. autoclass:: urwid.BoxWidget - -.. autoclass:: urwid.FixedWidget - - |