mirror of
https://github.com/powerline/powerline.git
synced 2025-07-28 16:24:57 +02:00
Add documentation files
This commit is contained in:
parent
f074c1fb29
commit
21032e989e
4
docs/configuration.rst
Normal file
4
docs/configuration.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. include:: configuration/vim.rst
|
2
docs/configuration/vim.rst
Normal file
2
docs/configuration/vim.rst
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Vim configuration
|
||||||
|
-----------------
|
@ -5,6 +5,10 @@ Powerline
|
|||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
:glob:
|
:glob:
|
||||||
|
|
||||||
|
introduction
|
||||||
|
installation
|
||||||
|
configuration
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
10
docs/installation.rst
Normal file
10
docs/installation.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
Powerline is intended to be installed as a system-wide Python package that
|
||||||
|
can be easily included in other projects.
|
||||||
|
|
||||||
|
.. note:: This project is currently unavailable on the PyPI due to a naming
|
||||||
|
conflict with an unrelated project.
|
||||||
|
|
||||||
|
.. include:: installation/vim.rst
|
20
docs/installation/vim.rst
Normal file
20
docs/installation/vim.rst
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
Vim installation
|
||||||
|
----------------
|
||||||
|
|
||||||
|
As a system-wide Python package
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Add the following line to your ``vimrc``::
|
||||||
|
|
||||||
|
python import plugin.vim.load_vim_plugin
|
||||||
|
|
||||||
|
Outside Python's search path
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
This requires you to source the plugin file with an absolute path to the
|
||||||
|
plugin location.
|
||||||
|
|
||||||
|
Add the following line to your ``vimrc``, where ``{path}`` is the path to
|
||||||
|
the main Powerline project folder::
|
||||||
|
|
||||||
|
source {path}/plugin/vim/powerline.vim
|
2
docs/introduction.rst
Normal file
2
docs/introduction.rst
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Introduction
|
||||||
|
============
|
Loading…
x
Reference in New Issue
Block a user