Started creating full documentation

This commit is contained in:
Danilo Bargen
2012-12-26 01:34:36 +01:00
parent 4217632ec8
commit e0d07aff79
6 changed files with 142 additions and 30 deletions

View File

@@ -0,0 +1,54 @@
The plugin API
==============
.. currentmodule:: jedi
If you want to set up an editor/IDE-plugin with **Jedi**, you first need to
``import jedi``. You then have direct access to the :class:`.Script`,
:class:`.NotFoundError` and :func:`.set_debug_function` objects.
API documentation
-----------------
Main class
~~~~~~~~~~
.. module:: api
.. autoclass:: Script
:members:
API Classes
~~~~~~~~~~~
.. module:: api_classes
.. autoclass:: Completion
:members:
.. autoclass:: Definition
:members:
.. autoclass:: RelatedName
:members:
Exceptions
~~~~~~~~~~
.. module:: api
.. autoexception:: NotFoundError
Useful functions
~~~~~~~~~~~~~~~~
.. module:: api
.. autofunction:: set_debug_function
Examples
--------
TODO