VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-06 22:14:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
David Halter
2013-05-11 13:53:00 +04:30
parent b2f2b7a779
commit 3681adef78
1 changed files with 21 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.rst
View File

@@ -52,50 +52,54 @@ Get the latest version from `github <https://github.com/davidhalter/jedi>`_
(master branch should always be kind of stable/working). (master branch should always be kind of stable/working).
Docs are available at `https://jedi.readthedocs.org/ Docs are available at `https://jedi.readthedocs.org/
<https://jedi.readthedocs.org/>`_. Pull requests with documentation enhancements <https://jedi.readthedocs.org/>`_. Pull requests with documentation
and/or fixes are awesome and most welcome. enhancements and/or fixes are awesome and most welcome. Jedi uses `semantic
versioning <http://semver.org/>`_.
Jedi uses `semantic versioning <http://semver.org/>`_.
Installation Installation
============ ============
See https://jedi.readthedocs.org/en/latest/docs/installation.html pip install jedi
Note: This just installs the Jedi library, not the editor plugins. For 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 information about how to make it work with your editor, refer to the
corresponding documentation. corresponding documentation.
You don't want to use ``pip``? Please refer to the `manual
<https://jedi.readthedocs.org/en/latest/docs/installation.html>`_.
Feature Support and Caveats Feature Support and Caveats
=========================== ===========================
Jedi really understands your Python code. For a comprehensive list what Jedi can Jedi really understands your Python code. For a comprehensive list what Jedi
do, see: https://jedi.readthedocs.org/en/latest/docs/features.html. A list of can do, see: `Features
<https://jedi.readthedocs.org/en/latest/docs/features.html>`_. A list of
caveats can be found on the same page. caveats can be found on the same page.
You can run Jedi on cPython 2.6, 2.7, 3.2 or 3.3, but it should also You can run Jedi on cPython 2.6, 2.7, 3.2 or 3.3, but it should also
understand/parse code older than those versions. understand/parse code older than those versions.
Tips on how to use Jedi efficiently can be found here: Tips on how to use Jedi efficiently can be found `here
https://jedi.readthedocs.org/en/latest/docs/recipes.html <https://jedi.readthedocs.org/en/latest/docs/recipes.html>`_.
A little history
================
See https://jedi.readthedocs.org/en/latest/docs/history.html
API for IDEs API for IDEs
============ ============
It's very easy to create an editor plugin that uses Jedi. See It's very easy to create an editor plugin that uses Jedi. See `Plugin API
https://jedi.readthedocs.org/en/latest/docs/plugin-api.html for more <https://jedi.readthedocs.org/en/latest/docs/plugin-api.html>`_ for more
information. information.
Development
===========
There's a pretty good and extensive `development documentation
<https://jedi.readthedocs.org/en/latest/docs/development.html>`_.
Testing Testing
======= =======