aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
Commit message (Collapse)AuthorAgeFilesLines
...
| * Rename PySide references to Qt for PythonCristian Maureira-Fredes2018-04-27588-588/+588
| | | | | | | | | | | | | | | | | | When referring to the project one should use "Qt for Python" and for the module "PySide2" Change-Id: I36497df245c9f6dd60d6e160e2fc805e48cefcae Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Doc: Add top-level index and getting started informationVenugopal Shivashankar2018-04-278-23/+210
| | | | | | | | | | | | | | | | | | - Updated the copyright text in the config file - Added the copyright to the footer in the template Change-Id: Iaadc293af524abea41873d04206516caec189c53 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.11Friedemann Kleint2018-04-161-2/+1
|\| | | | | | | Change-Id: I379c41e209c1a2cd61c8aa04bddd35a72210f0d3
| * Docs/inheritance_diagram.py: Remove compat importFriedemann Kleint2018-03-141-2/+1
| | | | | | | | | | | | | | | | | | Use class Directive from docutils.parsers.rst instead. Task-number: PYSIDE-363 Change-Id: I4356f0b0aa1eb0fc393bf8713be39c58fd281f4e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* | Remove CLucene license note from QtHelpFriedemann Kleint2018-03-151-19/+0
|/ | | | | | | | CLucene was removed by qttools/7f8c49d3dd0d4bd06ab57a71c7e2957aa5c224aa in 5.10. Change-Id: If5a82325fa3ab1ca0acc94059361865747ce270d Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Update the pysideversion.rst documentFriedemann Kleint2018-03-021-9/+9
| | | | | | Task-number: PYSIDE-363 Change-Id: Ibed88d97e70c7b6861ee47b23a7f4402683ba51e Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Documentation/inheritance_diagram.py: Fix import logicFriedemann Kleint2018-03-021-38/+36
| | | | | | | | | | | | | | | | The script tried to import a class or a module to obtain an introspectable object, which failed for nested classes like PySide2.QtCore.QStateMachine.SignalEvent, resulting in numerous warnings like: WARNING: Could not import class or module 'QStateMachine.SignalEvent' specified for inheritance diagram Rewrite the import to strip off the path components in a loop until the import succeeds and then walk up the attributes again to obtain the object. Task-number: PYSIDE-363 Change-Id: I33c6b4c6145b501a2f8f9ef3325610fefad9580d Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix inheritance_diagram.py to run with Python3Friedemann Kleint2018-02-271-6/+7
| | | | | | | | | | | | | | | | | | - Fix _class_info() to return a real list instead of list view, fixing: TypeError: can't pickle dict_values objects - Enclose font names in quotes, fixing dot complaining about a syntax error. - Encode the hash string get_graph_hash(), fixing TypeError: Unicode-objects must be encoded before hashing - Pass on options as dict instead of list to render_dot_html(), render_dot_latex() Task-number: PYSIDE-363 Task-number: PYSIDE-617 Change-Id: If050b73cf35ac6a6c58c0d3e5ea713c736ea842c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* sphinx: Remove deprecated config keysFriedemann Kleint2018-02-231-6/+0
| | | | | | | | | | | | | | Remove - html_add_permalinks: the key has been changed to str and has a default. - html_use_smartypants: Replaced by smartquotes and defaults to true. Fixes warnings: WARNING: The config value `html_add_permalinks' has type `bool', defaults to `str'. WARNING: html_use_smartypants option is deprecated. Smart quotes are on by default; if you want to disable them, use the smartquotes option. Task-number: PYSIDE-363 Change-Id: I85092597a860f58cc012220edbf0c03749326432 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Adapt QML basics tutorial for Qt Quick 2Venugopal Shivashankar2018-02-198-58/+57
| | | | | | | | | | - Update the helloworld example to use Qt Quick 2 import - Use second person style consistently in the tutorial set Task-number: PYSIDE-363 Change-Id: Ia2b6636e850433bd69e5d6b4fb36faa1cb7b0edb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Move and fix some snippetsFriedemann Kleint2018-02-198-3/+3
| | | | | | | | | | | | | | | | | | Fix warnings: While handling <snippet> in PySide2.QtQuick.QQuickImageProvider, line 20: Falling back to ".../qtdeclarative/examples/quick/imageprovider/imageprovider-example.qml" for "imageprovider/imageprovider-example.qml" [0] While handling <snippet> in PySide2.QtQuick.QQuickImageProvider, line 23: Falling back to ".../qtdeclarative/examples/quick/imageprovider/imageprovider.cpp" for "imageprovider/imageprovider.cpp" [0] While handling <snippet> in PySide2.QtQuick.QQuickImageProvider, line 25: Falling back to ".../qtdeclarative/examples/quick/imageprovider/imageprovider.cpp" for "imageprovider/imageprovider.cpp" [1] While handling <snippet> in PySide2.QtXml.QXmlSimpleReader, line 6: Falling back to ".../qtbase/src/xml/doc/snippets/simpleparse/main.cpp" for "simpleparse/main.cpp" [0] While handling <snippet> in PySide2.QtXml.QXmlSimpleReader, line 8: Falling back to ".../qtbase/src/xml/doc/snippets/simpleparse/main.cpp" for "simpleparse/main.cpp" [1] While handling <snippet> in PySide2.QtXml.QXmlSimpleReader, line 11: Falling back to ".../qtbase/src/xml/doc/snippets/simpleparse/main.cpp" for "simpleparse/main.cpp" [2] While handling <snippet> in PySide2.QtSvg.QSvgGenerator, line 5: Falling back to ".../qtsvg/examples/svg/svggenerator/window.cpp" for "svggenerator/window.cpp" [configure SVG generator] While handling <snippet> in PySide2.QtSvg.QSvgGenerator, line 8: Falling back to ".../qtsvg/examples/svg/svggenerator/window.cpp" for "svggenerator/window.cpp" [begin painting] While handling <snippet> in PySide2.QtSvg.QSvgGenerator, line 10: Falling back to ".../qtsvg/examples/svg/svggenerator/window.cpp" for "svggenerator/window.cpp" [end painting] While handling <snippet> in PySide2.QtSvg.QGraphicsSvgItem, line 8: Falling back to ".../qtsvg/src/svg/doc/snippets/src_svg_qgraphicssvgitem.cpp" for "src_svg_qgraphicssvgitem.cpp" [0] Task-number: PYSIDE-363 Change-Id: I32c73b2347e622e6594a017fde023d00bae864ec Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Initial fixes of the doc snippetsFriedemann Kleint2018-02-1519-48/+35
| | | | | | | | | | | Fix some findings obtained by comparing to the corresponding C++ snippets. Task-number: PYSIDE-363 Change-Id: I41b8a0b12f322ea9c44d58f82cb9cd497413c9d8 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Rename code snippet for QValidator classesFriedemann Kleint2018-02-131-0/+0
| | | | | | | | | | qt.shiboken: (doc) Error handling <snippet> in PySide2.QtGui.QRegExpValidator, line 9: Could not resolve "code/src_gui_util_qvalidator.cpp" in sources/pyside2/doc/codesnippets/doc/src/snippets", sources/pyside2/doc/codesnippets/examples qt.shiboken: (doc) Error handling <snippet> in PySide2.QtGui.QIntValidator, line 4: Could not resolve "code/src_gui_util_qvalidator.cpp" in sources/pyside2/doc/codesnippets/doc/src/snippets", sources/pyside2/doc/codesnippets/examples Task-number: PYSIDE-363 Change-Id: Iab4e64b0d9a810dc784edcc0239251fca2f5927f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Docs: Add QtQml, QtQuickWidgets and the Qt3D modulesFriedemann Kleint2018-02-133-12/+24
| | | | | | | | | Introduce an inner loop to doc/CMakeLists.txt allowing for handling qdocconf files that contain several modules. Task-number: PYSIDE-363 Change-Id: I71839999fe616b56fb3f2bab03bb21f49d0d1dac Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* qdoc: Add more include pathsFriedemann Kleint2018-02-011-3/+9
| | | | | | | | | | | Add the mkspec directory and the subdirectories containing the private module headers as is done in a standard Qt documentation build. This reduces the number of "Cannot tie this documentation to anything" warnings. Task-number: PYSIDE-363 Change-Id: I7231ada32970a0e3128bcf9ab38014025afe3751 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Remove unneeded documentation logosFriedemann Kleint2018-02-012-0/+0
| | | | | | Task-number: PYSIDE-363 Change-Id: Id24989eea3b47b04e37ce727c28deab4f34cefc1 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Update documentation HTML templatesFriedemann Kleint2018-02-012-25/+73
| | | | | | | | | | | - Fix some URLs - Add modules new in Qt 5 - Remove outdated modules - Remove outdated copyright URLs Task-number: PYSIDE-363 Change-Id: Iebdf0ee89db9f637a7317e199d71e164814c8f49 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add more qdocconf filesFriedemann Kleint2018-01-3120-0/+40
| | | | | | Task-number: PYSIDE-363 Change-Id: If7b3e7157fccb0494860664505df96c946e1c402 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Revive PySide2 API documentationTopi Reinio2018-01-0810-357/+95
| | | | | | | | | | | | | | - Rename qdoc3 to qdoc. - Run qdoc in single-exec mode. - Qt 5 documentation modules are added to the build from /qtmodules (see existing examples in that folder). - Fix modules.rst Done-with: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Done-with: Topi Reiniö <topi.reinio@qt.io> Task-number: PYSIDE-363 Change-Id: I47c3ec60c3132517424aef6c066a51c955e5bf2d Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* pysideinclude.py: Fix reading included filesVenugopal Shivashankar2018-01-081-1/+1
| | | | | | | | | | | | | | Doc: 'make apidoc' fails while reading lines from a qml file (Python 3). Apparently, the python code that reads the rsts and the corresponding snippet qml files, uses a stream reader that needs a byte stream and not a decoded string. Otherwise, the build fails with the following error: TypeError: can't concat str to bytes Task-number: PYSIDE-363 Change-Id: I84f97f2be37f9e81bca312013b49fad3a7d984c2 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Replace Python2-style constructsVenugopal Shivashankar2018-01-041-1/+1
| | | | | | | 'make apidoc' fails while generating htmls using python3. Change-Id: I21f1c0dcaa5bfb9cb5021ed98ce5db2138538195 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Merge remote-tracking branch 'origin/5.6' into 5.9Friedemann Kleint2017-12-211-1/+1
|\ | | | | | | Change-Id: I78039827d32c1d4d540a8b1b2afd4841e40d5c2c
| * Adjust inheritance_diagram.py exception to Python 3 syntaxChristian Tismer2017-12-211-1/+1
| | | | | | | | | | | | | | | | The file inheritance_diagram.py still had the old python 2 syntax. Obviously nobody tried to build documentation in Python 3... Change-Id: I0e245940a2593a1a5e93c7f538d8e73ca1001a0f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.6' into 5.9Friedemann Kleint2017-07-261-5/+0
|\| | | | | | | Change-Id: I678f69b4f9e66d9be5aebeb222d9cf5137e30998
| * Don't cancel build if python sphinx package is not installedAlexandru Croitor2017-07-251-5/+0
| | | | | | | | | | | | | | | | | | | | When building the docs target in PySide2, if the sphinx command is not successfully found, the build stops with an error. Instead of cancelling the build, just print a warning message just like it is done in the shiboken project file. Change-Id: I00ec7c306db5140f65973e622f4b1744cfd0d26e Reviewed-by: Christian Tismer <tismer@stackless.com>
| * move everying into sources/pyside2Oswald Buddenhagen2017-05-22814-0/+69387
| | | | | | in preparation for a subtree merge. this should not be necessary to do in a separate commit, but git is a tad stupid about following history correctly without it.
* move everying into sources/pyside2 (5.9 edition)Oswald Buddenhagen2017-05-22814-0/+69387
in preparation for a subtree merge. this should not be necessary to do in a separate commit, but git is a tad stupid about following history correctly without it.
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-20 04:20:35 +0000