aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/pyside-examples/examples.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2019-09-20 09:54:40 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2019-10-15 15:18:39 +0200
commit308157f01260c640e21f6972619d3b380c007acb (patch)
tree465ad2abfcd29d170a27e7389cfe9cf927e38b03 /sources/pyside2/doc/pyside-examples/examples.qdoc
parentf3a1f775eeb4152bd045e69cbcd618d4f462d22f (diff)
Doc: Set up necessary infra. for example doc generation
Qdoc must be made aware of the .py and .pyproject file types to generate the example page. In addition, it needs the URL to the example on https://code.qt.io/pyside-setup.git to link. Change-Id: I824898831475b6fe3f66df0cd16df62a9301a69d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside2/doc/pyside-examples/examples.qdoc')
-rw-r--r--sources/pyside2/doc/pyside-examples/examples.qdoc32
1 files changed, 32 insertions, 0 deletions
diff --git a/sources/pyside2/doc/pyside-examples/examples.qdoc b/sources/pyside2/doc/pyside-examples/examples.qdoc
new file mode 100644
index 000000000..d82b33cf7
--- /dev/null
+++ b/sources/pyside2/doc/pyside-examples/examples.qdoc
@@ -0,0 +1,32 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \group all-pyside-examples
+ \title All Qt for Python Examples
+ \brief A list of all the examples that are available with the Qt for Python package.
+*/