diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-05-28 17:07:03 +0200 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-06-01 20:04:04 +0000 |
| commit | 3b57289e6d8040bbb6747494bcc754bcd8751dfe (patch) | |
| tree | b64d93595dd8d5d47f3911b914ad926cdf276e0c /sources/pyside2/doc/conf.py.in | |
| parent | 7f798dfc9fc6e3e9756f06f0fedc821e16f1320a (diff) | |
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>
Diffstat (limited to 'sources/pyside2/doc/conf.py.in')
| -rw-r--r-- | sources/pyside2/doc/conf.py.in | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/sources/pyside2/doc/conf.py.in b/sources/pyside2/doc/conf.py.in index 26d99c7ed..50d2028e7 100644 --- a/sources/pyside2/doc/conf.py.in +++ b/sources/pyside2/doc/conf.py.in @@ -18,6 +18,7 @@ import sys, os # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.append('@CMAKE_CURRENT_SOURCE_DIR@') sys.path.append('@pyside_BINARY_DIR@') +sys.path.append('@CMAKE_CURRENT_SOURCE_DIR@/../../../examples/webenginewidgets/tabbedbrowser') # -- General configuration ----------------------------------------------------- @@ -26,7 +27,8 @@ sys.path.append('@pyside_BINARY_DIR@') #extensions = ['sphinx.ext.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', -'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude'] +'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude', +'sphinx.ext.viewcode'] rst_epilog = """ .. |project| replace:: Qt for Python |