Doc: Enable doc builds using the offline template

A new command-line option, --doc-build-online, enables
to choose online builds, otherwise offline docs are
built by default.

Change-Id: I34ef8a22ef3bd321bd972c4f2873e4321c9c336a
Fixes: PYSIDE-1292
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>

1 files changed, 69 insertions, 30 deletions

diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst
index 96cbf2ab2..72a26d19d 100644
--- a/sources/pyside2/doc/index.rst
+++ b/sources/pyside2/doc/index.rst
@@ -1,45 +1,84 @@
 |project|
 *********
 
-**Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_),
-so that you can use Qt5 APIs in your Python applications, and a binding generator tool (`Shiboken2`_)
-which can be used to expose C++ projects into Python.
+.. ifconfig:: output_format == 'html'
+
+    **Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_),
+    so that you can use Qt5 APIs in your Python applications, and a binding generator tool
+    (`Shiboken2 <shiboken2/index.html>`_) which can be used to expose C++ projects into Python.
+
+.. ifconfig:: output_format == 'qthelp'
+
+    **Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_),
+    so that you can use Qt5 APIs in your Python applications, and a binding generator tool
+    (`Shiboken2 <../shiboken2/index.html>`_) which can be used to expose C++ projects into Python.
 
 |project| is available under the LGPLv3/GPLv3 and the Qt commercial license.
 
 .. _Qt: https://doc.qt.io
 .. _PySide2: quickstart.html
-.. _Shiboken2: shiboken2/index.html
+
 
 Documentation
 =============
 
-.. raw:: html
-
-    <table class="special">
-        <colgroup>
-            <col style="width: 33%" />
-            <col style="width: 33%" />
-            <col style="width: 33%" />
-        </colgroup>
-        <tr>
-          <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td>
-          <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td>
-          <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td>
-        </tr>
-
-        <tr>
-          <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td>
-          <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td>
-          <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td>
-        </tr>
-
-        <tr>
-          <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td>
-          <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td>
-          <td><a href="shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
-        </tr>
-    </table>
+.. ifconfig:: output_format == 'html'
+
+    .. raw:: html
+
+        <table class="special">
+            <colgroup>
+                <col style="width: 33%" />
+                <col style="width: 33%" />
+                <col style="width: 33%" />
+            </colgroup>
+            <tr>
+                <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td>
+                <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td>
+                <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td>
+            </tr>
+
+            <tr>
+                <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td>
+                <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td>
+                <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td>
+            </tr>
+
+            <tr>
+                <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td>
+                <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td>
+                <td><a href="shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
+            </tr>
+        </table>
+
+.. ifconfig :: output_format == 'qthelp'
+
+    .. raw:: html
+
+        <table class="special">
+            <colgroup>
+                <col style="width: 33%" />
+                <col style="width: 33%" />
+                <col style="width: 33%" />
+            </colgroup>
+            <tr>
+                <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td>
+                <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td>
+                <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td>
+            </tr>
+
+            <tr>
+                <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td>
+                <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td>
+                <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td>
+            </tr>
+
+            <tr>
+                <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td>
+                <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td>
+                <td><a href="../shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
+            </tr>
+        </table>
 
 .. toctree::
    :hidden: