diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-05-20 14:15:15 +0100 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-05-20 14:15:15 +0100 |
| commit | 2563e6c5ee25ab07437f489ccdf0a629830295c5 (patch) | |
| tree | 556a9cafd79b3469a2cc6e1284bcac8881ba760d /docs/reference | |
| parent | d1a0135398092b9ba9744c30a1983b0454287cb3 (diff) | |
| download | urwid-2563e6c5ee25ab07437f489ccdf0a629830295c5.tar.gz | |
doc: sphinx params for Main Event Loops
This refactors the parameter docstrings
for MainLoop and TwistedEventLoop to use sphinx markup.
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/exceptions.rst | 4 | ||||
| -rw-r--r-- | docs/reference/index.rst | 1 | ||||
| -rw-r--r-- | docs/reference/main_loop.rst | 20 |
3 files changed, 12 insertions, 13 deletions
diff --git a/docs/reference/exceptions.rst b/docs/reference/exceptions.rst new file mode 100644 index 0000000..8a75a66 --- /dev/null +++ b/docs/reference/exceptions.rst @@ -0,0 +1,4 @@ +Exceptions +========== + +.. autoexception:: urwid.ExitMainLoop diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 927f555..5c9c6e7 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -9,3 +9,4 @@ Urwid Reference basic 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 |