Prepare sphinx autodoc

.travis.yml

@@ -9,11 +9,8 @@ before_install:
 - sudo npm install -g jshint
 
 install:
-- pip install cheetah
-- pip install twisted
-- pip install pyopenssl
+- pip install -r requirements.txt
 - pip install bandit
-- pip install flake8
 
 script: 
 - python -m compileall -l . -l plugin -l plugin/backport -l plugin/controllers -l plugin/controllers/models
@@ -33,6 +30,10 @@ after_success:
 - mv flake8_report.txt ./Rel
 - mv jshint1_report.txt ./Rel
 - mv jshint2_report.txt ./Rel
+- cd doc
+- make html
+- cd build
+- mv html ./Rel
 
 deploy:
   provider: pages

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -v
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = e2openplugin-OpenWebif
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/source/conf.py

@@ -0,0 +1,184 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../plugin'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'e2openplugin-OpenWebif'
+copyright = u'2018, E2OpenPlugins'
+author = u'E2OpenPlugins'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u'1.3.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinxcontrib.httpdomain'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'e2openplugin-OpenWebifdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'e2openplugin-OpenWebif.tex', u'e2openplugin-OpenWebif Documentation',
+     u'E2OpenPlugins', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'e2openplugin-openwebif', u'e2openplugin-OpenWebif Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'e2openplugin-OpenWebif', u'e2openplugin-OpenWebif Documentation',
+     author, 'e2openplugin-OpenWebif', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+intersphinx_mapping = {
+    'python': ('http://docs.python.org/2/', None),
+    'twisted': ('https://twistedmatrix.com/documents/16.2.0/api/', None),
+}
+
+autodoc_mock_imports = [
+                        'Screens',
+                        'Plugins',
+                        'Components',
+                        'enigma',
+                        'NavigationInstance',
+                        'ServiceReference',
+                        'RecordTimer',
+                        'timer',
+                        'Tools',
+                        'ipaddress',
+                        'controllers.models.config',
+                        'controllers.models.info'
+                        ]
+
+# -- Extension configuration -------------------------------------------------

doc/source/index.rst

@@ -0,0 +1,23 @@
+Welcome to e2openplugin-OpenWebif's documentation!
+==================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: httpserver
+    :members:
+
+.. automodule:: controllers.web
+    :members:
+
+.. automodule:: controllers.utilities
+    :members:
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

plugin/controllers/web.py

@@ -358,6 +358,7 @@ def P_supports_powerup_without_waking_tv(self, request):
 		.. note::
 
 			Not available in *Enigma2 WebInterface API*.
+
 		Args:
 			request (twisted.web.server.Request): HTTP request object
 		Returns:
@@ -383,6 +384,7 @@ def P_set_powerup_without_waking_tv(self, request):
 		.. note::
 
 			Not available in *Enigma2 WebInterface API*.
+
 		Args:
 			request (twisted.web.server.Request): HTTP request object
 		Returns:
@@ -1541,7 +1543,9 @@ def P_getcurrent(self, request):
 		Returns:
 			HTTP response with headers
 
+
 		.. http:get:: /web/getcurrent
+
 		"""
 		info = getCurrentService(self.session)
 		now = getNowNextEpg(info["ref"], 0, self.isJson)
@@ -1729,7 +1733,9 @@ def P_tsm3u(self, request):
 			request (twisted.web.server.Request): HTTP request object
 		Returns:
 			HTTP response with headers
+
 		.. http:get:: /web/ts.m3u
+
 		"""
 		self.isCustom = True
 		return getTS(self.session, request)
@@ -1750,7 +1756,9 @@ def P_streamcurrentm3u(self, request):
 			request (twisted.web.server.Request): HTTP request object
 		Returns:
 			HTTP response with headers
+
 		.. http:get:: /web/streamcurrent.m3u
+
 		"""
 		self.isCustom = True
 		return getStream(self.session, request, "streamcurrent.m3u")

requirements.txt

@@ -0,0 +1,9 @@
+Cheetah==2.4.4
+pyOpenSSL>=16.2.0
+Twisted==16.2.0
+flake8==3.5.0
+sphinx-rtd-theme>=0.2.4
+sphinxcontrib-napoleon>=0.6.1
+sphinxcontrib-websupport>=1.0.1
+Sphinx>=1.6.5
+sphinxcontrib-httpdomain>=1.5.0