From 4d5645504d16e1b0e4fab02f73aa43e3601b065e Mon Sep 17 00:00:00 2001 From: David Halter Date: Thu, 27 Dec 2012 19:06:22 +0100 Subject: [PATCH] sphinx: for now use automodule instead of documenting every class --- docs/source/plugin-api.rst | 44 ++++++++------------------------------ 1 file changed, 9 insertions(+), 35 deletions(-) diff --git a/docs/source/plugin-api.rst b/docs/source/plugin-api.rst index b19660c1..e7c0664d 100644 --- a/docs/source/plugin-api.rst +++ b/docs/source/plugin-api.rst @@ -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