From a2d99fd4529fec4ec4ce96bf6f05209c9abf800e Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sun, 6 Jul 2014 08:27:06 +0530 Subject: [PATCH] Add Viewer plugins API docs to the user manual --- manual/plugins.rst | 7 +++++++ src/calibre/customize/__init__.py | 4 ++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/manual/plugins.rst b/manual/plugins.rst index 1ebb180d46..c228fcd703 100644 --- a/manual/plugins.rst +++ b/manual/plugins.rst @@ -188,3 +188,10 @@ Preferences Plugins :members: :member-order: bysource +Viewer plugins +---------------- + +.. autoclass:: calibre.customize.ViewerPlugin + :show-inheritance: + :members: + :member-order: bysource diff --git a/src/calibre/customize/__init__.py b/src/calibre/customize/__init__.py index e2fa03fcca..9802e977ff 100644 --- a/src/calibre/customize/__init__.py +++ b/src/calibre/customize/__init__.py @@ -693,7 +693,7 @@ class ViewerPlugin(Plugin): # {{{ def load_fonts(self): ''' - This method is called once at viewer starup. It should load any fonts + This method is called once at viewer startup. It should load any fonts it wants to make available. For example:: def load_fonts(): @@ -734,7 +734,7 @@ class ViewerPlugin(Plugin): # {{{ def customize_context_menu(self, menu, event, hit_test_result): ''' This method is called every time the context (right-click) menu is - shown. You can use it to customize the context menu. event is the + shown. You can use it to customize the context menu. ``event`` is the context menu event and hit_test_result is the QWebHitTestResult for this event in the currently loaded document. '''