From 12d27922236bf22e59db3863c2273715eeec4a4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Rapinat?= Date: Thu, 4 Nov 2010 08:56:49 +0000 Subject: [PATCH] 4318: add relationship (new) and gen_plug (draft) API documentation svn: r16126 --- docs/api.rst | 2 + docs/gen/gen_plug.rst | 119 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 121 insertions(+) create mode 100644 docs/gen/gen_plug.rst diff --git a/docs/api.rst b/docs/api.rst index dcaeaa141..fe9545844 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -16,6 +16,7 @@ Contents: gen/gen_lib gen/gen_db + gen/gen_plug gen/gen_proxy gen/gen_utils @@ -29,6 +30,7 @@ Contents: corecli/cli coregui/gui + relationship utils Usefull snippets diff --git a/docs/gen/gen_plug.rst b/docs/gen/gen_plug.rst new file mode 100644 index 000000000..4168793e9 --- /dev/null +++ b/docs/gen/gen_plug.rst @@ -0,0 +1,119 @@ +############################ +The :mod:`gen.plug` Module +############################ + +Contents: + +.. automodule:: gen.plug + +***************************** +Plugins objects +***************************** + +Plugin +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.Plugin + :members: + :undoc-members: + :show-inheritance: + +BaseManager +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.BasePluginManager + :members: + :undoc-members: + :show-inheritance: + +Docgen +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.DocGenPlugin + :members: + :undoc-members: + :show-inheritance: + +Export +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.ExportPlugin + :members: + :undoc-members: + :show-inheritance: + +Gramplet +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.Gramplet + :members: + :undoc-members: + :show-inheritance: + +Import +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.ImportPlugin + :members: + :undoc-members: + :show-inheritance: + +Options +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.Options + :members: + :undoc-members: + :show-inheritance: + +Register +==================================== +.. automodule:: gen.plug +.. autoclass:: gen.plug.PluginRegister + :members: + :undoc-members: + :show-inheritance: + +Utils +==================================== +.. automodule:: gen.plug + :members: + :undoc-members: + :show-inheritance: + +Docbackend +==================================== +.. automodule:: gen.plug.docbackend + :members: + :undoc-members: + :show-inheritance: + +**TODO** + +DocGen +==================================== +.. automodule:: gen.plug.docgen + :members: + :undoc-members: + :show-inheritance: + +**TODO** + +Menu +==================================== +.. automodule:: gen.plug.menu + :members: + :undoc-members: + :show-inheritance: + +**TODO** + +Report +==================================== +.. automodule:: gen.plug.report + :members: + :undoc-members: + :show-inheritance: + +**TODO** +