mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-16 02:27:06 +08:00
Changed directory structure
This commit is contained in:
45
docs/docs/installation.rst
Normal file
45
docs/docs/installation.rst
Normal file
@@ -0,0 +1,45 @@
|
||||
Installation and Configuration
|
||||
==============================
|
||||
|
||||
You can either include *Jedi* as a submodule in your text editor plugin (like
|
||||
jedi-vim_ does it by default), or you can install it systemwide.
|
||||
|
||||
|
||||
System-wide installation via a package manager
|
||||
----------------------------------------------
|
||||
|
||||
You can install *Jedi* directly from pypi using pip::
|
||||
|
||||
sudo pip install jedi
|
||||
|
||||
If you want to install the current development version::
|
||||
|
||||
sudo pip install -e git://github.com/davidhalter/jedi.git#egg=jedi
|
||||
|
||||
.. note:: This just installs the Jedi library, not the editor plugins. For
|
||||
information about how to make it work with your editor, refer to the
|
||||
corresponding documentation.
|
||||
|
||||
|
||||
Manual installation from a downloaded package
|
||||
---------------------------------------------
|
||||
|
||||
If you prefer not to use an automated package installer, you can download a
|
||||
copy of *Jedi* and install it manually.
|
||||
|
||||
To install it, navigate to the directory containing `setup.py` on your console
|
||||
and type::
|
||||
|
||||
sudo python setup.py install
|
||||
|
||||
|
||||
Inclusion as a submodule
|
||||
------------------------
|
||||
|
||||
If you use an editor plugin like jedi-vim_, you can simply include *Jedi* as a
|
||||
git submodule of the plugin directory. Vim plugin managers like Vundle_ make it
|
||||
very easy to keep submodules up to date.
|
||||
|
||||
|
||||
.. _jedi-vim: https://github.com/davidhalter/jedi-vim
|
||||
.. _Vundle: https://github.com/gmarik/vundle
|
||||
Reference in New Issue
Block a user