Permalink
Fetching contributors…
Cannot retrieve contributors at this time
60 lines (42 sloc) 1.45 KB

Enki home page.

Plugin API documentation

This is API documentation. It lists all modules, which may be used by Enki plugins.

To create your own plugins, you will probably also need:

enki.core

Core creates basic user interface, provides basic functionality for user, contains plugin API.

.. toctree::

   core/core.rst
   core/mainwindow.rst
   core/actionmanager.rst
   core/workspace.rst
   core/document.rst
   core/config.rst
   core/uisettings.rst
   core/filefilter.rst
   core/locator.rst
   core/json_wrapper.rst

enki.lib

Code (but not widgets), which is not used by core, but, may be used by more than one plugin.

.. toctree::

    lib/buffpopen.rst
    lib/htmldelegate.rst
    lib/pathcompleter.rst

enki.widgets

Set of reusable widgets.

.. toctree::

    widgets/dockwidget.rst
    widgets/lineedit.rst
    widgets/colorbutton.rst
    widgets/termwidget.rst

enki.plugins

This package contains plugins, which extend the core with additional functionality.

Plugins do not export any public API and are not included to this docs. But code consists docstrings.

Every plugin is optional, therefore, no other modules are allowed to depend on plugin.