Doc: Document the tabbed browser demo

- Added docstrings to the examples sources
  to autogenerate the docs for the different parts.
- Updated the conf.py.in to include sphinx.ext.viewcode
  to generate html for every source file of the
  example.

Change-Id: I668c55070556ca49d12d38c8ec83f09313bffc36
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>

4 files changed, 8 insertions, 2 deletions

diff --git a/examples/webenginewidgets/tabbedbrowser/bookmarkwidget.py b/examples/webenginewidgets/tabbedbrowser/bookmarkwidget.py
index 01a69b921..6bd2b4586 100644
--- a/examples/webenginewidgets/tabbedbrowser/bookmarkwidget.py
+++ b/examples/webenginewidgets/tabbedbrowser/bookmarkwidget.py
@@ -122,6 +122,7 @@ def _serialize_model(model, directory):
 # Bookmarks as a tree view to be used in a dock widget with
 # functionality to persist and populate tool bars and menus.
 class BookmarkWidget(QTreeView):
+    """Provides a tree view to manage the bookmarks."""
 
     open_bookmark = QtCore.Signal(QUrl)
     open_bookmark_in_new_tab = QtCore.Signal(QUrl)
diff --git a/examples/webenginewidgets/tabbedbrowser/browsertabwidget.py b/examples/webenginewidgets/tabbedbrowser/browsertabwidget.py
index d9263be08..d85b8ad3d 100644
--- a/examples/webenginewidgets/tabbedbrowser/browsertabwidget.py
+++ b/examples/webenginewidgets/tabbedbrowser/browsertabwidget.py
@@ -50,6 +50,7 @@ from PySide2.QtWebEngineWidgets import (QWebEngineDownloadItem,
     QWebEnginePage, QWebEngineProfile)
 
 class BrowserTabWidget(QTabWidget):
+    """Enables having several tabs with QWebEngineView."""
 
     url_changed = QtCore.Signal(QUrl)
     enabled_changed = QtCore.Signal(QWebEnginePage.WebAction, bool)
diff --git a/examples/webenginewidgets/tabbedbrowser/downloadwidget.py b/examples/webenginewidgets/tabbedbrowser/downloadwidget.py
index 030dfc14b..437c534ec 100644
--- a/examples/webenginewidgets/tabbedbrowser/downloadwidget.py
+++ b/examples/webenginewidgets/tabbedbrowser/downloadwidget.py
@@ -48,7 +48,7 @@ from PySide2.QtWebEngineWidgets import QWebEngineDownloadItem
 
 # A QProgressBar with context menu for displaying downloads in a QStatusBar.
 class DownloadWidget(QProgressBar):
-
+    """Lets you track progress of a QWebEngineDownloadItem."""
     finished = QtCore.Signal()
     remove_requested = QtCore.Signal()
 
diff --git a/examples/webenginewidgets/tabbedbrowser/main.py b/examples/webenginewidgets/tabbedbrowser/main.py
index 12efdcd5c..09b6cc9ec 100644
--- a/examples/webenginewidgets/tabbedbrowser/main.py
+++ b/examples/webenginewidgets/tabbedbrowser/main.py
@@ -60,6 +60,7 @@ from PySide2.QtWebEngineWidgets import (QWebEngineDownloadItem, QWebEnginePage,
 main_windows = []
 
 def create_main_window():
+    """Creates a MainWindow using 75% of the available screen resolution."""
     main_win = MainWindow()
     main_windows.append(main_win)
     available_geometry = app.desktop().availableGeometry(main_win)
@@ -68,11 +69,14 @@ def create_main_window():
     return main_win
 
 def create_main_window_with_browser():
+    """Creates a MainWindow with a tab that loads the www.qt.io webpage."""
     main_win = create_main_window()
     return main_win.add_browser_tab()
 
 class MainWindow(QMainWindow):
-
+    """Provides the parent window that includes the BookmarkWidget,
+    BrowserTabWidget, and a DownloadWidget, to offer the complete
+    web browsing experience."""
     def __init__(self):
         super(MainWindow, self).__init__()