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

Docs: API overview

Browse Source
This commit is contained in:
Dave Halter
2020-03-16 09:35:47 +01:00
parent 950f5c186c
commit 25af28946e
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/api.rst
View File

@@ -10,10 +10,13 @@ API Overview
The API consists of a few different parts: The API consists of a few different parts:
- The main starting points for complete/goto: :class:`.Script` and :class:`.Interpreter` - The main starting points for complete/goto: :class:`.Script` and
:class:`.Interpreter`. If you work with Jedi you want to understand these
classes first.
- :ref:`API Result Classes <api-classes>` - :ref:`API Result Classes <api-classes>`
- :ref:`Python Versions/Virtualenv Support <environments>` with functions like - :ref:`Python Versions/Virtualenv Support <environments>` with functions like
:func:`.find_system_environments` and :func:`.find_virtualenvs` :func:`.find_system_environments` and :func:`.find_virtualenvs`
- A way to work with different :ref:`Folders / Projects <projects>`
- Helpful functions: :func:`.preload_module` and :func:`.set_debug_function` - Helpful functions: :func:`.preload_module` and :func:`.set_debug_function`
Script Script