diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-05-11 12:48:16 +0200 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-05-14 07:28:42 +0000 |
| commit | b97acb34365ab3c7395d59f691c57f565c8ec43d (patch) | |
| tree | e82d6a2a61f7ce7c10c2310045e5704915828c45 /sources/pyside2 | |
| parent | 981694fd50c8a4e71aaf334ccb6bdaa7470df519 (diff) | |
Doc: Add a link to the shiboken docs
Also reorganized the toctree structure by removing the sections.
Change-Id: I6d3bbc363b86d07cc05fd3b7391b3f8b0de3605c
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2')
| -rw-r--r-- | sources/pyside2/doc/conf.py.in | 9 | ||||
| -rw-r--r-- | sources/pyside2/doc/contents.rst | 16 | ||||
| -rw-r--r-- | sources/pyside2/doc/index.rst | 4 |
3 files changed, 12 insertions, 17 deletions
diff --git a/sources/pyside2/doc/conf.py.in b/sources/pyside2/doc/conf.py.in index 10c0af5f3..e5fc80fb7 100644 --- a/sources/pyside2/doc/conf.py.in +++ b/sources/pyside2/doc/conf.py.in @@ -23,7 +23,10 @@ sys.path.append('@pyside_BINARY_DIR@') # 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.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude'] +#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'] rst_epilog = """ .. |project| replace:: Qt for Python @@ -161,3 +164,7 @@ html_show_sourcelink = False # Output file base name for HTML help builder. #htmlhelp_basename = 'PySideDoc' + +# Link to the shiboken2 sphinx project to enable linking +# between the two projects. +intersphinx_mapping = {'shiboken2': ('@CMAKE_BINARY_DIR@/../shiboken2/doc/html','@CMAKE_BINARY_DIR@/../shiboken2/doc/html/objects.inv')} diff --git a/sources/pyside2/doc/contents.rst b/sources/pyside2/doc/contents.rst index f6e2f6abd..d31305889 100644 --- a/sources/pyside2/doc/contents.rst +++ b/sources/pyside2/doc/contents.rst @@ -6,24 +6,10 @@ gettingstarted.rst modules.rst - licenses.rst - -Tutorials -========= - -.. toctree:: - :maxdepth: 2 - tutorials/index.rst - -Other stuff -=========== - -.. toctree:: - :maxdepth: 1 - pysideapi2.rst pysideversion.rst + licenses.rst Module Index ============ diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst index 90c95ade9..26bfe998f 100644 --- a/sources/pyside2/doc/index.rst +++ b/sources/pyside2/doc/index.rst @@ -96,7 +96,9 @@ Qt Modules Provides access to sensor hardware via QML and Python interfaces and a motion gesture recognition API for devices. - -provides access to sensor hardware via QML and C++ interfaces. The Qt Sensors API also provides a motion gesture recognition API for devices. +|project| also comes with the +:doc:`Shiboken2 <shiboken2:contents>` generator that outputs C++ code +for CPython extensions. .. toctree:: :maxdepth: 2 |