Add documentation files

This commit is contained in:
Kim Silkebækken 2012-12-13 22:43:58 +01:00
parent f074c1fb29
commit 21032e989e
6 changed files with 42 additions and 0 deletions

4
docs/configuration.rst Normal file
View File

@ -0,0 +1,4 @@
Configuration
=============
.. include:: configuration/vim.rst

View File

@ -0,0 +1,2 @@
Vim configuration
-----------------

View File

@ -5,6 +5,10 @@ Powerline
:maxdepth: 3
:glob:
introduction
installation
configuration
Indices and tables
==================

10
docs/installation.rst Normal file
View 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
View 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
View File

@ -0,0 +1,2 @@
Introduction
============