Started creating full documentation

docs/source/conf.py

@@ -17,6 +17,7 @@ import sys, os
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('../../jedi'))
 
 # -- General configuration -----------------------------------------------------
 

docs/source/index.rst

@@ -3,10 +3,18 @@ Jedi – Python autocompletion that works!
 
 
 .. automodule:: jedi
+    :members:
+    :undoc-members:
 
 
+Contents
+========
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+
+   installation
+   plugin-api
 
 
 Indices and tables
@@ -15,4 +23,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/source/installation.rst

@@ -0,0 +1,45 @@
+Installation and Configuration
+==============================
+
+You can either include *Jedi* as a submodule in your text editor plugin (like
+jedi-vim_ does it by default), or you can install it systemwide.
+
+
+System-wide installation via a package manager
+----------------------------------------------
+
+You can install *Jedi* directly from pypi using pip::
+
+    sudo pip install jedi
+
+If you want to install the current development version::
+
+    sudo pip install -e git://github.com/davidhalter/jedi.git#egg=jedi
+
+.. 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
+    corresponding documentation.
+
+
+Manual installation from a downloaded package
+---------------------------------------------
+
+If you prefer not to use an automated package installer, you can download a
+copy of *Jedi* and install it manually.
+
+To install it, navigate to the directory containing `setup.py` on your console
+and type::
+
+    sudo python setup.py install
+
+
+Inclusion as a submodule
+------------------------
+
+If you use an editor plugin like jedi-vim_, you can simply include *Jedi* as a
+git submodule of the plugin directory. Vim plugin managers like Vundle_ make it
+very easy to keep submodules up to date.
+
+
+.. _jedi-vim: https://github.com/davidhalter/jedi-vim
+.. _Vundle: https://github.com/gmarik/vundle

docs/source/plugin-api.rst

@@ -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