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

sphinx: for now use automodule instead of documenting every class

Browse Source
This commit is contained in:
David Halter
2012-12-27 19:06:22 +01:00
parent 16236857bc
commit 4d5645504d
1 changed files with 9 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/source/plugin-api.rst
View File

@@ -11,43 +11,17 @@ If you want to set up an editor/IDE-plugin with **Jedi**, you first need to
API documentation
-----------------
Main class
~~~~~~~~~~
API Interface
~~~~~~~~~~~~~
.. module:: api
.. automodule:: api
:undoc-members:
.. autoclass:: Script
API Classes
~~~~~~~~~~~
.. module:: api_classes
.. autoclass:: BaseDefinition
.. autoclass:: Completion
:show-inheritance:
.. autoclass:: Definition
:show-inheritance:
.. autoclass:: RelatedName
:show-inheritance:
Exceptions
~~~~~~~~~~
.. module:: api
.. autoexception:: NotFoundError
Useful functions
~~~~~~~~~~~~~~~~
.. module:: api
.. autofunction:: set_debug_function
API Return Classes
~~~~~~~~~~~~~~~~~~
.. automodule:: api_classes
:undoc-members:
Examples
--------
@@ -71,7 +45,7 @@ Completions:
>>> completions[1].word
'loads'
Definitions:
Definitions / Goto:
.. sourcecode:: python