VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2026-01-31 10:55:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Installation notes for docs moved down in priority a bit

Browse Source
This commit is contained in:
Dave Halter
2020-03-15 23:52:52 +01:00
parent 0f25eb9c9a
commit 43363936cd
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/installation.rst
View File

@@ -3,6 +3,15 @@
Installation and Configuration
==============================
.. warning:: Most people will want to install Jedi as a submodule/vendored and
not through pip/system wide. The reason for this is that it makes sense that
the plugin that uses Jedi has always access to it. Otherwise Jedi will not
work properly when virtualenvs are activated. So please read the
documentation of your editor/IDE plugin to install Jedi.
For plugin developers, Jedi works best if it is always available. Vendoring
is a pretty good option for that.
You can either include |jedi| as a submodule in your text editor plugin (like
jedi-vim_ does by default), or you can install it systemwide.

2
docs/index.rst
View File

@@ -21,10 +21,10 @@ Docs
:maxdepth: 2
docs/usage
docs/installation
docs/features
docs/api
docs/api-classes
docs/installation
docs/settings
docs/development
docs/testing