From c3099ce48b25bd6496be1aaca9c482dee65b883e Mon Sep 17 00:00:00 2001 From: ZyX Date: Sat, 16 Aug 2014 13:22:31 +0400 Subject: [PATCH] Add lister reference --- docs/source/configuration.rst | 1 + docs/source/configuration/listers.rst | 21 +++++++++++++++++++++ docs/source/develop/segments.rst | 2 ++ 3 files changed, 24 insertions(+) create mode 100644 docs/source/configuration/listers.rst diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index 88663a6c..8ed3fe7d 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -133,4 +133,5 @@ References configuration/reference configuration/segments + configuration/listers configuration/local diff --git a/docs/source/configuration/listers.rst b/docs/source/configuration/listers.rst new file mode 100644 index 00000000..c0db03d0 --- /dev/null +++ b/docs/source/configuration/listers.rst @@ -0,0 +1,21 @@ +**************** +Lister reference +**************** + +Listers are special segment collections which allow to show some list of +segments for each entity in the list of entities (multiply their segments list +by a list of entities). E.g. ``powerline.listers.vim.tablister`` presented with +``powerline.segments.vim.tabnr`` and ``….file_name`` as segments will emit +segments with buffer names and tabpage numbers for each tabpage shown by vim. + +Listers appear in configuration as irregular segments having ``segment_list`` as +their type and ``segments`` key with a list of segments (a bit more details in +:ref:`Themes section of configuration reference `). + +Currently only Vim listers are available. + +Vim listers +----------- + +.. automodule:: powerline.listers.vim + :members: diff --git a/docs/source/develop/segments.rst b/docs/source/develop/segments.rst index 592f3052..2c9aecc1 100644 --- a/docs/source/develop/segments.rst +++ b/docs/source/develop/segments.rst @@ -1,3 +1,5 @@ +.. _dev-segments: + **************** Writing segments ****************