tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs 

- Added notes about where common and extension-specific configuration is located
- Added common.paths config.json option description
- Fixed user-defined segments location found in segments section
- Fixed Themes/segments/module reference text
This commit is contained in:
ZyX 2013-01-20 03:14:31 +04:00 committed by Kim Silkebækken
parent 69846cd0cc
commit f1976c2022
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/configuration.rst
View File

@ -48,6 +48,9 @@ colorschemes.
Common configuration Common configuration
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
Common configuration is a subdictionary that is a value of ``common`` key in
:file:`powerline/config.json` file.
``dividers`` ``dividers``
Defines the dividers used in all Powerline extensions. This option Defines the dividers used in all Powerline extensions. This option
should usually only be changed if you don't have a patched font, or if should usually only be changed if you don't have a patched font, or if
@ -57,9 +60,19 @@ Common configuration
background colors, while the ``soft`` dividers are used to divide background colors, while the ``soft`` dividers are used to divide
segments with the same background color. segments with the same background color.
``paths``
.. _config-common-paths
Defines additional paths which will be searched for modules when using
:ref:`module segment option <config-themes-seg-module>`. Paths defined here
have priority when searching for modules.
Extension-specific configuration Extension-specific configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Common configuration is a subdictionary that is a value of ``ext`` key in
:file:`powerline/config.json` file.
``colorscheme`` ``colorscheme``
Defines the colorscheme used for this extension. Defines the colorscheme used for this extension.
@ -167,7 +180,7 @@ Themes
Function module, only required for function segments. Defaults to Function module, only required for function segments. Defaults to
``powerline.ext.{extension}.segments``. Default is overriden by ``powerline.ext.{extension}.segments``. Default is overriden by
:ref:`theme option <config-themes-default_module>`. :ref:`default_module theme option <config-themes-default_module>`.
``name`` ``name``
.. _config-themes-seg-name: .. _config-themes-seg-name:
@ -234,9 +247,9 @@ Segments
Segments are written in Python, and the default segments provided with Segments are written in Python, and the default segments provided with
Powerline are located in Powerline are located in
:file:`powerline/ext/{extension}/segments/{module}.py`. User-defined :file:`powerline/ext/{extension}/segments/{module}.py`. User-defined segments
segments can be defined in the corresponding path in the user's config can be defined in any module in ``sys.path`` or :ref:`paths common configuration
directory. option <config-common-paths>`, import is always absolute.
Segments are regular Python functions, and they may accept arguments. All Segments are regular Python functions, and they may accept arguments. All
arguments should have a default value which will be used for themes that arguments should have a default value which will be used for themes that