Commit Graph

341 Commits

Author SHA1 Message Date
Kim Silkebækken bc7c5b784d Merge branch 'update-docs' into develop
TODO:

* Add info about code layout, debugging tips, etc.
* Add "developing powerline" section to docs (not contributing document)

Ref #287
2013-03-25 13:55:31 +01:00
kierun 491b48fd9c Added terminus font and urxvt documentation.
How to use terminus and urxvt and still get the powerline glyphs .
2013-03-25 08:03:44 +00:00
ZyX 1351207462 Some fixes for flake8 2013-03-24 19:59:56 +04:00
ZyX ed435f8063 Add required pl argument to segments
Fixes #340
Ref #330
2013-03-24 19:44:01 +04:00
ZyX a021916428 Make update_first configurable 2013-03-24 19:35:25 +04:00
ZyX 674a211cda Remove escape sequences from default strings in documentation
Note: to properly view some values in browser you need the browser to use 
patched font or fontconfig. Though there is not much difference between some 
cryptic escape sequence and singe wrongly displayed character.
2013-03-17 22:26:57 +04:00
ZyX 34fba2286a Fix documentation for wrapped functions 2013-03-17 22:07:27 +04:00
ZyX 19b45e609a Fix documentation for threaded segments 2013-03-17 22:06:52 +04:00
Kim Silkebækken d966921f04 Remove contibuting info from docs 2013-03-15 15:23:45 +01:00
Kim Silkebækken c4e618e17c Update authors and contributors list 2013-03-15 14:35:08 +01:00
ZyX 6f3703e312 Improve ambiwidth handling, readd additional_escapes
Fixes #307
2013-03-12 13:11:59 +01:00
ZyX ae62aee529 Renamed term_24bit_colors to term_truecolor 2013-03-11 19:11:10 +04:00
Kim Silkebækken 111eaa27e8 Combine vim modelines and Python encoding declarations
Ref #314
2013-03-11 10:40:09 +01:00
Kim Silkebækken 6748701fcb Add vim modelines to all Python files
Added with `sed -i '2i# vim:fenc=utf-8:noet' `find -name '*.py'`` and
fixed in a couple of files without the UTF-8 encoding on top.

Ref #314
2013-03-11 08:11:25 +01:00
Kim Silkebækken 162f5ac55b Change license from CC BY-SA to the MIT license
Refs #299.
2013-03-08 17:58:06 +01:00
Kim Silkebækken cb87cfbe0f Update credits and PR guidelines 2013-03-03 22:11:39 +01:00
ZyX 47cfde0ecc Add support for python-2.6 2013-03-03 21:03:17 +01:00
ZyX 307dfd7212 Improve documentation 2013-03-03 21:03:05 +01:00
ZyX a8ccfd4350 Add ambiwidth problems information to troubleshooting section 2013-02-26 21:17:25 +01:00
Foo 43d9639534 Fix zsh/zpython issue 2013-02-24 22:23:43 +01:00
ZyX f319ddc33b Ignore highlight definitions for function segments
Also removed divider_highlight_group from configuration: it is actually used
only in function segments.

Fixes #215
2013-02-24 22:22:48 +01:00
ZyX 01b34a7893 Split colorschemes and add better gradient support
- Splitted colorschemes into colors definitions file (TODO: remove non-colors
  definitions like weather_condition_hot and base00) and actual colorscheme.
- Removed dictionary containing groups definitions for all groups for all modes,
  now colorscheme is queried for this each time.
- Moved determination of colors from theme to renderer.
- Added gradients definitions (actually, only one) to new colors file.
- Made line_percent with gradient=True use new gradients.
2013-02-24 22:22:31 +01:00
ZyX f211bb6c74 Add ability to override configuration options
Related changes:
- Moved all non-ASCII symbols into `segment_data`
- Added --config_path, replaced nargs='*' with better action='append'
- Added g:powerline_config_path vim option
- Added ipython overrides (via additional arguments to setup() or c.Powerline)

TODO: support for non-string scalars in vim overrides.

Fixes #231
2013-02-24 22:22:13 +01:00
ZyX c86b047ed4 Add ability to specify some segment keys once in top theme 2013-02-24 22:22:10 +01:00
Kim Silkebækken b347d53b6d Remove obsolete Vundle warning from docs 2013-02-20 14:07:26 +01:00
Kim Silkebækken ea56f4c26b Split optional dependencies to python packages and other apps
Closes #227.
2013-02-18 19:40:32 +01:00
ZyX baaf6cde1d Switch from `status` + `ls-files` to `status --ignored` 2013-02-18 09:07:51 +01:00
ZyX c45747a3b8 Ease E858/E860 errors debugging
E858: Eval did not return a valid python object
E860: Eval did not return a valid python 3 object
2013-02-15 21:06:08 +04:00
Kim Silkebækken 2caa136f26 Add docs for all segments 2013-02-08 17:35:15 +01:00
Kim Silkebækken 55ad48f0e6 Update sphinx configuration 2013-02-08 17:32:23 +01:00
ZyX 5399265135 Add note about zpython branch
TODO: To be removed after (if) zsh maintainers accept the patch.

Refs #104.
2013-02-08 14:43:32 +01:00
Kim Silkebækken 4e4a2b2ef8 Add tips & tricks to the docs
Closes #182.
2013-02-07 12:32:34 +01:00
Kim Silkebækken 8b8de32be9 Improve vim plugin loading
Several of the plugin loading methods have been joined into one plugin
file that will be loaded by updating the runtimepath. More informative
error messages will be displayed if Python support is missing or if the
module import fails.

Note that this commit will break existing plugin loading, the new
method with updating the runtimepath will be required.

Closes #156.
Closes #181.
2013-02-07 12:14:15 +01:00
Kim Silkebækken bfdb7f8028 Refactor segment rendering
This commit introduces the following changes to themes and segment
rendering:

- Spacer segments are now regular string/function type segments with
  "width": "auto" in the themes.
- The "rjust"/"ljust" properties have been replaced by the "width"
  option combined with a new "align" option.
- Renderer._render_segments() is now a generator which renders each
  segment separately, and assigns the rendered contents to
  "_rendered_hl" and "_rendered_raw" in the segment dict.
- Renderer.render() returns the segments by joining the "_rendered_hl"
  values for each segment.
- Spacer segment widths are calculated in the render() method, and
  assigned to "_space_left" and "_space_right" in the segment dict.
  These spaces are then applied in Renderer._render_segments().
- All space characters are converted to no-break spaces (U+00A0) in the
  "_rendered_hl" property.

Refs #113.
Refs #154.
2013-02-01 16:22:08 +01:00
Kim Silkebækken 597f67b85a Add Qtile widget 2013-01-30 10:35:01 +01:00
Kim Silkebækken a3600158de Add a quick setup guide to the docs 2013-01-28 13:55:45 +01:00
Kim Silkebækken bda7384aa7 Add Awesome WM widget 2013-01-28 12:30:11 +01:00
ZyX 0b251425da Add IPython prompt support 2013-01-28 06:35:56 +01:00
Kim Silkebækken c06f8836b3 Update docs and create a common terminal feature support matrix 2013-01-25 10:48:44 +01:00
Kim Silkebækken 16b82cf070 Add configuration option and docs for 24-bit terminal colors
Closes #81.
2013-01-25 10:08:12 +01:00
Kim Silkebækken cfe96ff010 Fix minor doc issues 2013-01-25 09:40:07 +01:00
Kim Silkebækken e49f760510 Use hex strings for RGB colors in colorschemes
Previously you'd have to convert a hex number to an integer, this change
makes it possible to use a hex string instead which is much more useful.
2013-01-25 09:37:03 +01:00
Kim Silkebækken 6ac9f0d602 Restructure and improve installation docs
The installation docs have been split into separate guides for OS X and
Linux, with OS-specific troubleshooting as part of the installation
guide.

Terminal emulator support tables have been added to both guides.

Closes #121.
2013-01-24 17:35:16 +01:00
Kim Silkebækken b86f79cf9e Restructure docs slightly
The header levels have been switched to correspond more with the Sphinx
suggested standards and the troubleshooting section has been
restructured to make it easier to find solutions. Minor markup changes
and other changes are also included in this commit.
2013-01-23 10:24:07 +01:00
Kim Silkebækken 40d542af12 Add troubleshooting info for PuTTy users
Refs #107.
2013-01-23 09:56:58 +01:00
Kim Silkebækken 2a9edc19ca Update troubleshooting info for ImportErrors on OS X
Refs #39.
Refs #95.
2013-01-22 18:50:37 +01:00
ZyX f4a95fbbbf Rename prompt.* to powerline.*
Reasons:
- prompt.* is a bad name for installing into /usr/share/zsh/site-contrib
- prompt.* does not conform powerline.vim and powerline.conf (vim and tmux)
2013-01-22 20:51:26 +04:00
Kim Silkebækken 0cb218212e Update installation instructions for tmux and shell prompts 2013-01-22 17:26:43 +01:00
Kim Silkebækken 7c19381b24 Update optional dependency list 2013-01-22 14:23:21 +01:00
Kim Silkebækken 424f979136 Make it possible to return several segment in segment functions
This requires a couple of minor changes to custom segments. The segment
`highlight` key has been renamed to `highlight_group`, and segment
functions must return a list of segments dicts instead of just a dict.

Closes #88.
2013-01-22 10:58:41 +01:00
Kim Silkebækken ced333dd29 Add note about Python 3 support in docs 2013-01-21 22:03:56 +01:00
Kim Silkebækken bee427eb42 Add Python 3.3 support
Support for unicode literals was reintroduced in Python 3.3 which makes
supporting both Python 2 and Python 3 much easier, so this will be the
minimum supported Python 3 version.

Closes #8.
2013-01-21 20:42:57 +01:00
Kim Silkebækken 77f66cbbc9 Add additional dependency info 2013-01-21 20:38:41 +01:00
Kim Silkebækken e64ef3c337 Fix zsh prompt example 2013-01-21 17:30:35 +01:00
Kim Silkebækken 25c5a6d978 Update zsh prompt example in docs 2013-01-21 10:53:51 +01:00
Kim Silkebækken 7be62ba563 Use code-blocks in docs 2013-01-21 10:16:34 +01:00
Kim Silkebækken 7db8aa074f Update usage docs
Refs #79.
2013-01-21 10:14:23 +01:00
なつき 4e97fd95d8 Add Pathogen/Vundle support
Closes #79.
2013-01-21 09:56:01 +01:00
Kim Silkebækken c561922eed Add info about Gentoo Live ebuild 2013-01-20 19:49:06 +01:00
Kim Silkebækken 84edefbe2e Update docs with new module paths 2013-01-20 19:48:56 +01:00
ZyX f1976c2022 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
2013-01-20 19:39:59 +01:00
Kim Silkebækken f108ab04c4 Update pip install URI in the docs 2013-01-20 19:15:12 +01:00
ZyX 78e54e0c84 Addd “default_module” theme key support
Refs #3.
2013-01-19 16:55:39 +01:00
Kim Silkebækken c5b37b3913 Add troubleshooting info for iTerm2
Closes #65.
2013-01-18 16:53:32 +01:00
Kim Silkebækken 2ace41857f Update font installation instructions
Refs #60.
2013-01-18 16:44:31 +01:00
Kim Silkebækken 56f06f8871 Update font installation instructions
Refs #60.
2013-01-18 10:58:23 +01:00
Kim Silkebækken 1a99fbd36a Update terminal prompt usage instructions
Closes #56.
2013-01-17 17:07:58 +01:00
Kim Silkebækken 8a5b8719cd Escape command in prompt usage instructions 2013-01-17 10:08:51 +01:00
Kim Silkebækken 20b17cebe0 Add troubleshooting info about OSX ImportError
Closes #39.
2013-01-17 10:03:29 +01:00
Kim Silkebækken 6207f90734 Add troubleshooting info about NameError in MacVim
Refs #48.
2013-01-17 10:03:00 +01:00
Kim Silkebækken f18bf7087d Add troubleshooting info for iTerm2 question mark issue
Closes #27.
Refs #48.
2013-01-17 10:01:48 +01:00
Kim Silkebækken 7d613baec2 Fix font patching instructions for OS X
Closes #46.
2013-01-17 10:01:11 +01:00
Kim Silkebækken 6bf501df51 Add usage instructions for terminal/tmux 2013-01-17 09:42:39 +01:00
Kim Silkebækken b7ff63ccc0 Separate colorschemes by extension
Refs #45.
2013-01-16 08:44:17 +01:00
Kim Silkebækken 07771d7773 Add Liam Curry to contributors list
Refs #44.
2013-01-16 08:31:41 +01:00
Kim Silkebækken a26d5e5319 Add troubleshooting info for Windows gVim + git users
Closes #36.
2013-01-09 13:18:53 +01:00
Kim Silkebækken 536120aab8 Re-add note about PyPI which got removed from the docs
Refs #34.
2013-01-08 15:01:28 +01:00
Kim Silkebækken 7a7c971bd1 Move plugin loading with :source into separate file
This should resolve the issue with duplicate paths in sys.path by only
updating sys.path if the plugin is loaded using :source instead of
:python. sys.path is now updated in source_plugin.vim, which checks if
the user has Python installed, and updates sys.path before sourcing the
actual plugin file.

Refs #17.
Refs #19.
Refs #21.
2013-01-02 08:38:28 +01:00
Kim Silkebækken f423ba11c8 Add information about Python support 2012-12-21 11:20:50 +01:00
Kim Silkebækken 9f60daaf78 Use :file: for file references in the docs 2012-12-20 16:20:56 +01:00
Kim Silkebækken 9cc1233307 Add configuration docs 2012-12-20 15:47:01 +01:00
Kim Silkebækken 50fa8a33ca Update docs and README 2012-12-19 14:46:14 +01:00
ZyX-I 69f726af1a Purge out the requirement to use sudo
There is no need in regenerating font cache in *all* directories. 
Make documentation suggest to regenerate just `~/.fonts` cache 
which actually changed.
2012-12-19 08:36:41 +04:00
Kim Silkebækken def9091662 Update installation instructions
Closes #13.
2012-12-18 17:18:37 +01:00
Kim Silkebækken bda5c59889 Add screenshots to docs 2012-12-18 16:03:15 +01:00
Kim Silkebækken d28003c973 Add font patcher docs 2012-12-18 15:22:31 +01:00
Kim Silkebækken af1f3ec7bd Move vim plugin to the vim extension directory 2012-12-17 15:45:23 +01:00
Kim Silkebækken df0244700c Fix typo in doc filename 2012-12-17 15:32:01 +01:00
Kim Silkebækken 9ba8570bf7 Update documentation and version 2012-12-17 15:24:42 +01:00
Kim Silkebækken 05505c3dd1 Restructure docs 2012-12-14 15:23:26 +01:00
Kim Silkebækken f3a03aa26a Update docs structure for gh-pages 2012-12-14 15:16:38 +01:00