Fix documentation bug 853 - "Provide constants for Qt and PySide version"

Reviewer: Marcelo Lira <marcelo.lira@openbossa.org>
          Renato Araújo <renato.filho@openbossa.org>

2 files changed, 32 insertions, 0 deletions

diff --git a/doc/contents.rst b/doc/contents.rst
index 691bce69f..c2ea806a2 100644
--- a/doc/contents.rst
+++ b/doc/contents.rst
@@ -21,6 +21,7 @@ Other stuff
     :maxdepth: 1
 
     pysideapi2.rst
+    pysideversion.rst
 
 Module Index
 ============
diff --git a/doc/pysideversion.rst b/doc/pysideversion.rst
new file mode 100644
index 000000000..23666b8ed
--- /dev/null
+++ b/doc/pysideversion.rst
@@ -0,0 +1,31 @@
+Getting PySide and Qt version
+*****************************
+
+PySide exports their version numbers among the version of Qt used to compile PySide in a pythonnic way, you can check it using the variables:
+
+::
+
+    import PySide
+
+    # Prints PySide version
+    # e.g. 1.0.2
+    print PySide.__version__
+
+    # Gets a tuple with each version component
+    # e.g. (1, 0, 2, 'final', 1)
+    print PySide.__version_info__
+
+    # Prints the Qt version used to compile PySide
+    # e.g. "4.7.2"
+    print PySide.QtCore.__version__
+
+    # Gets a tuple with each version components of Qt used to compile PySide
+    # e.g. (4, 7, 2)
+    print PySide.QtCore.__version_info__
+
+
+Note that the Qt version used to compile PySide may differ from the version used to run PySide, to get the current running Qt version you can do:
+
+::
+
+    print PySide.QtCore.qVersion()