diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 00000000..839f6004 --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,4 @@ +Configuration +============= + +.. include:: configuration/vim.rst diff --git a/docs/configuration/vim.rst b/docs/configuration/vim.rst new file mode 100644 index 00000000..c5fea4e6 --- /dev/null +++ b/docs/configuration/vim.rst @@ -0,0 +1,2 @@ +Vim configuration +----------------- diff --git a/docs/index.rst b/docs/index.rst index 07d14c06..47c19cd8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,10 @@ Powerline :maxdepth: 3 :glob: + introduction + installation + configuration + Indices and tables ================== diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 00000000..407dcc3c --- /dev/null +++ b/docs/installation.rst @@ -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 diff --git a/docs/installation/vim.rst b/docs/installation/vim.rst new file mode 100644 index 00000000..2d6d4bd9 --- /dev/null +++ b/docs/installation/vim.rst @@ -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 diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 00000000..c516b331 --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,2 @@ +Introduction +============