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

Restructure API documentation

Browse Source
This commit is contained in:
Dave Halter
2020-03-16 09:27:01 +01:00
parent 8f96cbdabf
commit 950f5c186c
1 changed files with 12 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/docs/api.rst
View File

@@ -8,38 +8,29 @@ API Overview
.. _api: .. _api:
API Documentation
-----------------
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`
- Helpful functions: :func:`.preload_module` and :func:`.set_debug_function`
- :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`
- Helpful functions: :func:`.preload_module` and :func:`.set_debug_function`
Script Script
~~~~~~ ------
.. autoclass:: jedi.Script .. autoclass:: jedi.Script
:members: :members:
Interpreter Interpreter
~~~~~~~~~~~ -----------
.. autoclass:: jedi.Interpreter .. autoclass:: jedi.Interpreter
:members: :members:
Helper Functions
~~~~~~~~~~~~~~~~
.. autofunction:: jedi.preload_module
.. autofunction:: jedi.set_debug_function
.. _projects: .. _projects:
Projects Projects
~~~~~~~~ --------
.. automodule:: jedi.api.project .. automodule:: jedi.api.project
@@ -50,7 +41,7 @@ Projects
.. _environments: .. _environments:
Environments Environments
~~~~~~~~~~~~ ------------
.. automodule:: jedi.api.environment .. automodule:: jedi.api.environment
@@ -63,8 +54,14 @@ Environments
.. autoclass:: jedi.api.environment.Environment .. autoclass:: jedi.api.environment.Environment
:members: :members:
Helper Functions
----------------
.. autofunction:: jedi.preload_module
.. autofunction:: jedi.set_debug_function
Errors Errors
~~~~~~ ------
.. autoexception:: jedi.InternalError .. autoexception:: jedi.InternalError
.. autoexception:: jedi.RefactoringError .. autoexception:: jedi.RefactoringError