Skip to content

Commit db78bd7

Browse files
LokaltogLokaltog
committed
Create gh-pages for '9ba8570 Update documentation and version'
1 parent 31a8f7d commit db78bd7

18 files changed

Lines changed: 593 additions & 85 deletions

‎_sources/configuration.txt‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
Configuration
22
=============
3-
4-
.. include:: configuration/vim.rst

‎_sources/fontpatching.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Font patching
2+
=============

‎_sources/index.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ Powerline
77

88
introduction
99
overview
10+
fontpatching
1011
configuration
12+
troubleshooting
13+
license-credits
1114

1215
Indices and tables
1316
==================

‎_sources/introduction.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
Introduction
22
============
3+
4+
This is the next version of Powerline, implemented in Python. It aims to
5+
resolve some of the "unresolvable" problems of the vimscript implementation,
6+
as well as providing a common code base for all projects that use Powerline
7+
in some way (e.g. shell prompts and tmux themes).
8+
9+
The project is currently in beta, and most of the functionality in the old
10+
vimscript project is already implemented.
11+
12+
Feature highlights
13+
------------------
14+
15+
* **Better performance.** Python performs quite a bit better than vimscript,
16+
and by having most of the code in Python instead of vimscript it's also
17+
much easier to profile the code and eliminate bottlenecks.
18+
* **A much leaner code base.** With most of the functionality of the old
19+
project implemented the new version consists of less than half the amount
20+
of code.
21+
* **Automatic removal of less important segments in small windows.** Not all
22+
information is equally important to have in the statusline, and segments
23+
with e.g. encoding and file format information are automatically removed
24+
in smaller windows.
25+
* **Dynamic statusline evaluation in Python.** Statuslines are dynamically
26+
rendered in Python instead of relying on vim's statusline flags, which
27+
allows much more flexibility when creating statuslines.
28+
* **The possibility of adding more segments.** Because of vim's hardcoded
29+
limitation of 80 statusline options, the vimscript implementation
30+
triggered an error when adding more segments to the default theme. Since
31+
segment contents are now rendered as plain text in Python it's possible to
32+
add many more segments in the statusline before reaching this limit.
33+
* **New and improved theme and colorscheme syntax.** Themes and colorschemes
34+
are now written in JSON, with a much cleaner syntax that's easier to learn
35+
and work with. Themes and colorschemes are also much more configurable,
36+
and it's easy to write your own and store them in your home config
37+
directory (usually ``~/.config/powerline``).

‎_sources/licence-credits.txt‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
License
2+
=======
3+
4+
.. image:: http://i.creativecommons.org/l/by-sa/3.0/88x31.png
5+
:target: `Creative Commons Attribution-ShareAlike 3.0 Unported License`_
6+
7+
Powerline is licensed under a `Creative Commons Attribution-ShareAlike 3.0
8+
Unported License`_.
9+
10+
.. _`Creative Commons Attribution-ShareAlike 3.0 Unported License`: http://creativecommons.org/licenses/by-sa/3.0/
11+
12+
Credits
13+
=======
14+
15+
:Author: `Kim Silkebækken <https://github.com/Lokaltog>`_
16+
:Main contributors:
17+
* `ZyX-I <https://github.com/ZyX-I>`_
18+
19+
Contributing
20+
============
21+
22+
If you experience any bugs or have any feature requests, please `open an
23+
issue on GitHub <https://github.com/Lokaltog/powerline/issues>`_.
24+
25+
Pull request guidelines
26+
-----------------------
27+
28+
This project uses `Git Flow`_ for maintaining a clean history and
29+
a consistent way of branching and merging new features. All commit messages
30+
must follow the guidelines described in `Tim Pope's blog post about git
31+
commit messages`_.
32+
33+
All code must use tabs for indentation and spaces for alignment.
34+
35+
Python code must pass flake8 tests with ``flake8 --ignore=W191,E501`` (ignore
36+
tab warnings and line length errors).
37+
38+
.. _`Git Flow`: http://nvie.com/posts/a-successful-git-branching-model/
39+
.. _`Tim Pope's blog post about git commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
40+

‎_sources/overview.txt‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,45 @@ Overview
44
Requirements
55
------------
66

7+
Powerline requires Python 2.7 to work.
8+
9+
Vim plugin requirements
10+
^^^^^^^^^^^^^^^^^^^^^^^
11+
12+
The vim plugin requires a vim version with Python 2.7 support compiled in.
13+
You can check if your vim supports Python 2 by running ``vim --version
14+
| grep +python``.
15+
16+
Vim version 7.3.661 or newer is recommended for performance reasons.
17+
718
Installation
819
------------
920

1021
Powerline is intended to be installed as a system-wide Python package that
1122
can be easily included in other projects.
1223

24+
Powerline is available `on the AUR
25+
<https://aur.archlinux.org/packages/powerline-git/>`_ for Arch Linux users.
26+
1327
.. note:: This project is currently unavailable on the PyPI due to a naming
1428
conflict with an unrelated project.
1529

16-
.. include:: installation/vim.rst
17-
1830
Usage
1931
-----
32+
33+
Vim usage
34+
^^^^^^^^^
35+
36+
If Powerline is installed as a system-wide Python package, you can enable
37+
the plugin by adding the following line to your ``vimrc``::
38+
39+
python import powerline.plugin.vim.load_vim_plugin
40+
41+
If Powerline is installed outside Python's search path (e.g. by having the
42+
git repo in your dotfiles folder) you'll have to source the vim plugin file
43+
with an absolute path to the plugin location.
44+
45+
Add the following line to your ``vimrc``, where ``{path}`` is the path to
46+
the main Powerline project folder::
47+
48+
source {path}/powerline/plugin/vim/powerline.vim

‎_sources/troubleshooting.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Troubleshooting
2+
===============

‎configuration.html‎

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
<head>
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
99

10-
<title>Configuration &mdash; Powerline dev documentation</title>
10+
<title>Configuration &mdash; Powerline beta documentation</title>
1111

1212
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1313
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1414

1515
<script type="text/javascript">
1616
var DOCUMENTATION_OPTIONS = {
1717
URL_ROOT: '',
18-
VERSION: 'dev',
18+
VERSION: 'beta',
1919
COLLAPSE_INDEX: false,
2020
FILE_SUFFIX: '.html',
2121
HAS_SOURCE: true
@@ -24,8 +24,9 @@
2424
<script type="text/javascript" src="_static/jquery.js"></script>
2525
<script type="text/javascript" src="_static/underscore.js"></script>
2626
<script type="text/javascript" src="_static/doctools.js"></script>
27-
<link rel="top" title="Powerline dev documentation" href="index.html" />
28-
<link rel="prev" title="Overview" href="overview.html" />
27+
<link rel="top" title="Powerline beta documentation" href="index.html" />
28+
<link rel="next" title="Troubleshooting" href="troubleshooting.html" />
29+
<link rel="prev" title="Font patching" href="fontpatching.html" />
2930
</head>
3031
<body>
3132
<div class="related">
@@ -35,9 +36,12 @@ <h3>Navigation</h3>
3536
<a href="genindex.html" title="General Index"
3637
accesskey="I">index</a></li>
3738
<li class="right" >
38-
<a href="overview.html" title="Overview"
39+
<a href="troubleshooting.html" title="Troubleshooting"
40+
accesskey="N">next</a> |</li>
41+
<li class="right" >
42+
<a href="fontpatching.html" title="Font patching"
3943
accesskey="P">previous</a> |</li>
40-
<li><a href="index.html">Powerline dev documentation</a> &raquo;</li>
44+
<li><a href="index.html">Powerline beta documentation</a> &raquo;</li>
4145
</ul>
4246
</div>
4347

@@ -48,9 +52,6 @@ <h3>Navigation</h3>
4852

4953
<div class="section" id="configuration">
5054
<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
51-
<div class="section" id="vim-configuration">
52-
<h2>Vim configuration<a class="headerlink" href="#vim-configuration" title="Permalink to this headline"></a></h2>
53-
</div>
5455
</div>
5556

5657

@@ -59,17 +60,12 @@ <h2>Vim configuration<a class="headerlink" href="#vim-configuration" title="Perm
5960
</div>
6061
<div class="sphinxsidebar">
6162
<div class="sphinxsidebarwrapper">
62-
<h3><a href="index.html">Table Of Contents</a></h3>
63-
<ul>
64-
<li><a class="reference internal" href="#">Configuration</a><ul>
65-
<li><a class="reference internal" href="#vim-configuration">Vim configuration</a></li>
66-
</ul>
67-
</li>
68-
</ul>
69-
7063
<h4>Previous topic</h4>
71-
<p class="topless"><a href="overview.html"
72-
title="previous chapter">Overview</a></p>
64+
<p class="topless"><a href="fontpatching.html"
65+
title="previous chapter">Font patching</a></p>
66+
<h4>Next topic</h4>
67+
<p class="topless"><a href="troubleshooting.html"
68+
title="next chapter">Troubleshooting</a></p>
7369
<h3>This Page</h3>
7470
<ul class="this-page-menu">
7571
<li><a href="_sources/configuration.txt"
@@ -99,9 +95,12 @@ <h3>Navigation</h3>
9995
<a href="genindex.html" title="General Index"
10096
>index</a></li>
10197
<li class="right" >
102-
<a href="overview.html" title="Overview"
98+
<a href="troubleshooting.html" title="Troubleshooting"
99+
>next</a> |</li>
100+
<li class="right" >
101+
<a href="fontpatching.html" title="Font patching"
103102
>previous</a> |</li>
104-
<li><a href="index.html">Powerline dev documentation</a> &raquo;</li>
103+
<li><a href="index.html">Powerline beta documentation</a> &raquo;</li>
105104
</ul>
106105
</div>
107106
<div class="footer">

‎fontpatching.html‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
5+
6+
<html xmlns="http://www.w3.org/1999/xhtml">
7+
<head>
8+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9+
10+
<title>Font patching &mdash; Powerline beta documentation</title>
11+
12+
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
13+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14+
15+
<script type="text/javascript">
16+
var DOCUMENTATION_OPTIONS = {
17+
URL_ROOT: '',
18+
VERSION: 'beta',
19+
COLLAPSE_INDEX: false,
20+
FILE_SUFFIX: '.html',
21+
HAS_SOURCE: true
22+
};
23+
</script>
24+
<script type="text/javascript" src="_static/jquery.js"></script>
25+
<script type="text/javascript" src="_static/underscore.js"></script>
26+
<script type="text/javascript" src="_static/doctools.js"></script>
27+
<link rel="top" title="Powerline beta documentation" href="index.html" />
28+
<link rel="next" title="Configuration" href="configuration.html" />
29+
<link rel="prev" title="Overview" href="overview.html" />
30+
</head>
31+
<body>
32+
<div class="related">
33+
<h3>Navigation</h3>
34+
<ul>
35+
<li class="right" style="margin-right: 10px">
36+
<a href="genindex.html" title="General Index"
37+
accesskey="I">index</a></li>
38+
<li class="right" >
39+
<a href="configuration.html" title="Configuration"
40+
accesskey="N">next</a> |</li>
41+
<li class="right" >
42+
<a href="overview.html" title="Overview"
43+
accesskey="P">previous</a> |</li>
44+
<li><a href="index.html">Powerline beta documentation</a> &raquo;</li>
45+
</ul>
46+
</div>
47+
48+
<div class="document">
49+
<div class="documentwrapper">
50+
<div class="bodywrapper">
51+
<div class="body">
52+
53+
<div class="section" id="font-patching">
54+
<h1>Font patching<a class="headerlink" href="#font-patching" title="Permalink to this headline"></a></h1>
55+
</div>
56+
57+
58+
</div>
59+
</div>
60+
</div>
61+
<div class="sphinxsidebar">
62+
<div class="sphinxsidebarwrapper">
63+
<h4>Previous topic</h4>
64+
<p class="topless"><a href="overview.html"
65+
title="previous chapter">Overview</a></p>
66+
<h4>Next topic</h4>
67+
<p class="topless"><a href="configuration.html"
68+
title="next chapter">Configuration</a></p>
69+
<h3>This Page</h3>
70+
<ul class="this-page-menu">
71+
<li><a href="_sources/fontpatching.txt"
72+
rel="nofollow">Show Source</a></li>
73+
</ul>
74+
<div id="searchbox" style="display: none">
75+
<h3>Quick search</h3>
76+
<form class="search" action="search.html" method="get">
77+
<input type="text" name="q" />
78+
<input type="submit" value="Go" />
79+
<input type="hidden" name="check_keywords" value="yes" />
80+
<input type="hidden" name="area" value="default" />
81+
</form>
82+
<p class="searchtip" style="font-size: 90%">
83+
Enter search terms or a module, class or function name.
84+
</p>
85+
</div>
86+
<script type="text/javascript">$('#searchbox').show(0);</script>
87+
</div>
88+
</div>
89+
<div class="clearer"></div>
90+
</div>
91+
<div class="related">
92+
<h3>Navigation</h3>
93+
<ul>
94+
<li class="right" style="margin-right: 10px">
95+
<a href="genindex.html" title="General Index"
96+
>index</a></li>
97+
<li class="right" >
98+
<a href="configuration.html" title="Configuration"
99+
>next</a> |</li>
100+
<li class="right" >
101+
<a href="overview.html" title="Overview"
102+
>previous</a> |</li>
103+
<li><a href="index.html">Powerline beta documentation</a> &raquo;</li>
104+
</ul>
105+
</div>
106+
<div class="footer">
107+
&copy; Copyright Kim Silkebækken.
108+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
109+
</div>
110+
</body>
111+
</html>

‎genindex.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
<head>
1010
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1111

12-
<title>Index &mdash; Powerline dev documentation</title>
12+
<title>Index &mdash; Powerline beta documentation</title>
1313

1414
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1515
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1616

1717
<script type="text/javascript">
1818
var DOCUMENTATION_OPTIONS = {
1919
URL_ROOT: '',
20-
VERSION: 'dev',
20+
VERSION: 'beta',
2121
COLLAPSE_INDEX: false,
2222
FILE_SUFFIX: '.html',
2323
HAS_SOURCE: true
@@ -26,7 +26,7 @@
2626
<script type="text/javascript" src="_static/jquery.js"></script>
2727
<script type="text/javascript" src="_static/underscore.js"></script>
2828
<script type="text/javascript" src="_static/doctools.js"></script>
29-
<link rel="top" title="Powerline dev documentation" href="index.html" />
29+
<link rel="top" title="Powerline beta documentation" href="index.html" />
3030
</head>
3131
<body>
3232
<div class="related">
@@ -35,7 +35,7 @@ <h3>Navigation</h3>
3535
<li class="right" style="margin-right: 10px">
3636
<a href="#" title="General Index"
3737
accesskey="I">index</a></li>
38-
<li><a href="index.html">Powerline dev documentation</a> &raquo;</li>
38+
<li><a href="index.html">Powerline beta documentation</a> &raquo;</li>
3939
</ul>
4040
</div>
4141

@@ -83,7 +83,7 @@ <h3>Navigation</h3>
8383
<li class="right" style="margin-right: 10px">
8484
<a href="#" title="General Index"
8585
>index</a></li>
86-
<li><a href="index.html">Powerline dev documentation</a> &raquo;</li>
86+
<li><a href="index.html">Powerline beta documentation</a> &raquo;</li>
8787
</ul>
8888
</div>
8989
<div class="footer">

0 commit comments

Comments
 (0)