aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2018-05-18 16:45:35 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2018-05-18 16:45:35 +0200
commit3f8c8702ea295f39357e7c66f46e5138f56bcc9f (patch)
tree9ca65a7f94d544ba4b36f239c4a48852ad8a7b09 /sources/pyside2/doc
parent5fce76074c01e52a22151133a1e3a2cf71cfe535 (diff)
parentdf1a619d65d8e5db91f3c8db46b00872b461e334 (diff)
Merge remote-tracking branch 'origin/5.9' into 5.11
Diffstat (limited to 'sources/pyside2/doc')
-rw-r--r--sources/pyside2/doc/_templates/layout.html2
-rw-r--r--sources/pyside2/doc/_themes/pysidedocs/static/pysidelogo.pngbin12969 -> 9473 bytes
-rw-r--r--sources/pyside2/doc/additionaldocs.lst2
-rw-r--r--sources/pyside2/doc/conf.py.in9
-rw-r--r--sources/pyside2/doc/contents.rst16
-rw-r--r--sources/pyside2/doc/index.rst4
6 files changed, 15 insertions, 18 deletions
diff --git a/sources/pyside2/doc/_templates/layout.html b/sources/pyside2/doc/_templates/layout.html
index 561bed8ee..6ab1276a3 100644
--- a/sources/pyside2/doc/_templates/layout.html
+++ b/sources/pyside2/doc/_templates/layout.html
@@ -8,7 +8,7 @@
<div id="container">
<div class="header">
<div class="header_container">
- <div class="logo"><a href="http://www.pyside.org"><img alt="PySide" src="{{ pathto('_static/pysidelogo.png', 1) }}" width="199" height="102" /></a></div>
+ <div class="logo"><a href="http://www.pyside.org"><img alt="PySide" src="{{ pathto('_static/pysidelogo.png', 1) }}"/></a></div>
<div class="related">
<ul>
{%- block rootrellink %}
diff --git a/sources/pyside2/doc/_themes/pysidedocs/static/pysidelogo.png b/sources/pyside2/doc/_themes/pysidedocs/static/pysidelogo.png
index 076c1057c..882a004dd 100644
--- a/sources/pyside2/doc/_themes/pysidedocs/static/pysidelogo.png
+++ b/sources/pyside2/doc/_themes/pysidedocs/static/pysidelogo.png
Binary files differ
diff --git a/sources/pyside2/doc/additionaldocs.lst b/sources/pyside2/doc/additionaldocs.lst
index ff03d3656..037cb60f7 100644
--- a/sources/pyside2/doc/additionaldocs.lst
+++ b/sources/pyside2/doc/additionaldocs.lst
@@ -50,7 +50,9 @@
# fi
# fi
# done
+# A line enclosed in [] denotes a (relative) target directory
+[overviews]
animation-overview.webxml
animation.webxml
application-windows.webxml
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