diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/canvas.rst | 31 | ||||
| -rw-r--r-- | docs/reference/display_modules.rst | 36 | ||||
| -rw-r--r-- | docs/reference/index.rst | 2 | ||||
| -rw-r--r-- | docs/reference/text_layout.rst | 8 |
4 files changed, 77 insertions, 0 deletions
diff --git a/docs/reference/canvas.rst b/docs/reference/canvas.rst new file mode 100644 index 0000000..8079461 --- /dev/null +++ b/docs/reference/canvas.rst @@ -0,0 +1,31 @@ +Canvas Classes and Functions +============================ + +.. currentmodule:: urwid + +Canvas Classes +-------------- + +.. autoclass:: Canvas + +.. autoclass:: TextCanvas + +.. autoclass:: BlankCanvas + +.. autoclass:: SolidCanvas + +.. autoclass:: CompositeCanvas + +CompositeCanvas Builders +------------------------ + +.. autofunction:: CanvasCombine + +.. autofunction:: CanvasJoin + +.. autofunction:: CanvasOverlay + +CanvasCache +----------- + +.. autoclass:: CanvasCache diff --git a/docs/reference/display_modules.rst b/docs/reference/display_modules.rst new file mode 100644 index 0000000..b9ab2db --- /dev/null +++ b/docs/reference/display_modules.rst @@ -0,0 +1,36 @@ +Display Modules +=============== + +.. currentmodule:: urwid + +raw_display +----------- + +.. module:: urwid.raw_display + +.. autoclass:: Screen + +curses_display +-------------- + +.. module:: urwid.curses_display + +.. autoclass:: Screen + +web_display +----------- + +.. module:: urwid.web_display + +.. autoclass:: Screen + +html_fragment +------------- + +.. module:: urwid.html_fragment + +.. autoclass:: HtmlGenerator + +.. autofunction:: screenshot_init + +.. autofunction:: screenshot_collect diff --git a/docs/reference/index.rst b/docs/reference/index.rst index b436924..3f5a219 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,8 +6,10 @@ Urwid Reference main_loop widget + display_modules list_walkers canvas + text_layout constants exceptions meta diff --git a/docs/reference/text_layout.rst b/docs/reference/text_layout.rst new file mode 100644 index 0000000..8baf8ce --- /dev/null +++ b/docs/reference/text_layout.rst @@ -0,0 +1,8 @@ +Text Layout Classes +=================== + +.. currentmodule:: urwid + +.. autoclass:: TextLayout + +.. autoclass:: StandardTextLayout |