Doc: Use product name and python module names appropriately

Configured replaceable text entities so that updating instances
of product and module names in the doc is less cumbersome.

Change-Id: I6ef8adcc4324775eeb8a48bf81294effb0ea12d5
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>

6 files changed, 14 insertions, 19 deletions

diff --git a/sources/pyside2/doc/conf.py.in b/sources/pyside2/doc/conf.py.in
index 21ce43ad2..10c0af5f3 100644
--- a/sources/pyside2/doc/conf.py.in
+++ b/sources/pyside2/doc/conf.py.in
@@ -26,7 +26,8 @@ sys.path.append('@pyside_BINARY_DIR@')
 extensions = ['sphinx.ext.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude']
 
 rst_epilog = """
-.. |project| replace:: PySide
+.. |project| replace:: Qt for Python
+.. |pymodname| replace:: PySide2
 """
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/sources/pyside2/doc/contents.rst b/sources/pyside2/doc/contents.rst
index 9ba3663f8..4a9c04e6c 100644
--- a/sources/pyside2/doc/contents.rst
+++ b/sources/pyside2/doc/contents.rst
@@ -1,4 +1,4 @@
-Qt for Python Documentation
+|project| Documentation
 ***************************
 
 .. toctree::
diff --git a/sources/pyside2/doc/gettingstarted.rst b/sources/pyside2/doc/gettingstarted.rst
index bb58c1734..55212b1ba 100644
--- a/sources/pyside2/doc/gettingstarted.rst
+++ b/sources/pyside2/doc/gettingstarted.rst
@@ -33,7 +33,8 @@ guide you through the development process:
         import random
         from PySide2 import QtCore, QtWidgets, QtGui
 
-  These imports should provide access to the APIs specific to those Qt modules.
+  The |pymodname| Python module provides access to the Qt APIs as its submodule.
+  In this case, you are importing the :code:`QtCore`, :code:`QtWidgets`, and :code:`QtGui` submodules.
 
 * Define a class named :code:`MyWidget`, which extends QWidget and includes a QPushButton and QLabel.
 
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst
index 47437d986..c8345597f 100644
--- a/sources/pyside2/doc/index.rst
+++ b/sources/pyside2/doc/index.rst
@@ -1,8 +1,10 @@
 |project|
 *************
 
-|project| enables the use of Qt 5 APIs in Python applications. It lets Python
-developers utilize the full power of Qt. The following Qt5 modules are supported:
+The |project| product enables the use of Qt5 APIs in Python applications. It
+lets Python developers utilize the full potential of Qt, using the |pymodname| module.
+The |pymodname| module provides access to the individual Qt modules such as QtCore,
+QtGui, and so on. The following is the list of supported Qt5 modules:
 
 Qt Modules
 ===========
diff --git a/sources/pyside2/doc/pyside-config.qdocconf.in b/sources/pyside2/doc/pyside-config.qdocconf.in
index 4a9af5994..2083913e3 100644
--- a/sources/pyside2/doc/pyside-config.qdocconf.in
+++ b/sources/pyside2/doc/pyside-config.qdocconf.in
@@ -1,5 +1,5 @@
 buildversion              = @PYSIDE_QT_VERSION@
-navigation.homepage       = PySide
+navigation.homepage       = Qt for Python
 
 outputdir                 = @DOC_DATA_DIR@
 outputformats             = WebXML
diff --git a/sources/pyside2/doc/pysideapi2.rst b/sources/pyside2/doc/pysideapi2.rst
index 5769ca83b..f1cc13391 100644
--- a/sources/pyside2/doc/pysideapi2.rst
+++ b/sources/pyside2/doc/pysideapi2.rst
@@ -1,20 +1,11 @@
 .. _pysideapi2:
 
-|project| API
+|pymodname| API
 ***************
 
-Since the beginning one of the PySide goals was to be API compatible with PyQt4,
-but with some (documented) exceptions. For example, PySide will not export to
-Python components marked as deprecated on C++ Qt. All the modifications follow
-the `PSEP101 <http://www.pyside.org/docs/pseps/psep-0101.html>`_ as its guideline.
-
-The release 4.7 of PyQt4 came with improvements on the pythonic front, being
-the extinction of QString a good example. PySide followed this change, except in
-one point: while PyQt4 has conserved the old behavior as optional, PySide
-bindings fully adopted the new API - completely removing QString. No turning
-back. Thus remember to update your source code to the new API, this will ensure
-your code will run on both bindings.
-
+One of the goals of |pymodname| is to be API compatible with PyQt5,
+with certain exceptions. For example, |pymodname| will not export C++ components
+that are marked as deprecated by Qt.
 
 __hash__() function return value
 ================================