update doc

dklemm · Apr 14, 2018 · e1a40c4 · e1a40c4
1 parent f10f36a
commit e1a40c4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,12 @@
 # OpenWebif
 OpenWebif is an open source web interface for Enigma2 based set-top boxes (STBs).
 
+## Documentation
+[Link](http://e2openplugins.github.io/e2openplugin-OpenWebif/)
+
+## API Wiki
+[Link](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif/wiki/OpenWebif-API-documentation)
+
 ## Screenshots
 [Link](screenshots/SCREENSHOTS.md)
 

diff --git a/doc/source/controller.rst b/doc/source/controller.rst
@@ -8,10 +8,12 @@ Basic Controllers
 
 .. automodule:: controllers.root
     :members:
+    :show-inheritance:
 
 .. automodule:: controllers.base
     :special-members:
     :members:
+    :show-inheritance:
 
 .. automodule:: controllers.utilities
     :members:
@@ -22,4 +24,5 @@ Web Controllers
 
 .. automodule:: controllers.web
     :members:
+    :show-inheritance:
 
diff --git a/plugin/controllers/root.py b/plugin/controllers/root.py
@@ -42,6 +42,9 @@
 
 
 class RootController(BaseController):
+	"""
+	Root Web Controller
+	"""
 	def __init__(self, session, path=""):
 		BaseController.__init__(self, path=path, session=session)
 		piconpath = getPiconPath()

diff --git a/plugin/controllers/web.py b/plugin/controllers/web.py
@@ -52,7 +52,6 @@ class WebController(BaseController):
 	Fork of *Enigma2 WebInterface API* as described in e.g.
 	https://dream.reichholf.net/e2web/.
 	"""
-
 	def __init__(self, session, path=""):
 		BaseController.__init__(self, path=path, session=session)
 		self.putChild("stream", StreamController(session))
@@ -279,7 +278,7 @@ def P_zap(self, request):
 		Returns:
 			HTTP response with headers
 
-		.. http:get:: /web/services.m3u
+		.. http:get:: /web/zap
 
 			:query string sRef: service reference
 			:query string title: service title