aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* | Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-03-192-1/+7
|\| | | | | | | Change-Id: I137dc1d4b7dc73ee8ad4cff2eb031e2aaead2644
| * PySide2 documentation: Do not add module namesFriedemann Kleint2019-03-141-0/+2
| | | | | | | | | | | | | | Add the corresponding Sphinx configuration entry. Change-Id: I73f213275544089f75d45b98d85df320c71c3fb1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| * PySide2: Fix documentation build with module subsetsFriedemann Kleint2019-03-122-1/+5
| | | | | | | | | | | | | | | | | | Document the tabbedbrowser tutorial only when QtWebEngineWidgets are present. Otherwise, the sphinx run will fail since autodoc cannot import the QtWebEngineWidget Python module. Change-Id: I23e671e15aa1725b20e4d0db17942f3fbc04bf20 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devFriedemann Kleint2019-03-011-6/+6
|\| | | | | | | Change-Id: I0f3c2de6195b863dc60ecbb988e4e14182e3ad03
| * Doc: Avoid marketing Qt for Python as a productVenugopal Shivashankar2019-02-281-6/+6
| | | | | | | | | | | | | | | | It is an offering that provides Python bindings for Qt, enabling Python developers to explore the power of Qt. Change-Id: I19a487c9141554da04bd360b23e69ad25bee4dd2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Doc: Fix issuesVenugopal Shivashankar2019-02-126-58/+23
| | | | | | | | | | | | | | | | | | | | | | - Update the title for chapter 1 to be in line with the other chapter titles. - Fix a typo - Remove unified diffs to highlight changes to code between chapters Change-Id: Iccf671c876fd78626014f52e58df49ed720aa7c1 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devFriedemann Kleint2019-02-121-1/+1
|\| | | | | | | Change-Id: Iafe51380b453ee1849ed65f5342d79c76c21d28d
| * Modernize cmake buildAlexandru Croitor2019-02-071-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a CMake super project that includes the shiboken2, PySide2 and pyside2-tools subprojects, so that it's possible to build everything from Qt Creator (or any other IDE that supports CMake) with minimal set up effort, and thus inform the IDE CMake integration of all relevant files, for easier code editing, navigation and refactoring. This also lays the foundation for allowing 3rd parties to use the shiboken2 generator to generate custom modules. This is achieved by eliminating various hardcoded paths for libraries and include directories. Start using CMake targets throughout the build code to correctly propagate link flags and include dirs for libshiboken and shiboken2 executable targets. Same for the libpyside target. Generate two separate cmake config files (build-tree / install-tree) that can be used with find_package(Shiboken2), to make sure that the PySide2 project can be built as part of the super project build. This is currently the only way I've found to allow the super build to work. Note that for the build-tree find_package() to work, the CMAKE_MODULE_PATH has to be adjusted in the super project file. The generated config files contain variables and logic that allow usage of the installed shiboken package in downstream projects (PySide2). This involves things like getting the includes and libraries for the currently found python interpreter, the shiboken build type (release or debug), was shiboken built with limited api support, etc. Generate 2 separate (build-tree and install-tree) config files for PySide2, similar to how it's done for the shiboken case, for pyside2-tools to build correctly. Install shiboken2 target files using install(EXPORT) to allow building PySide2 with an installed Shiboken2 package (as opposed to one that is built as part of the super project). Same with PySide2 targets for pyside2-tools subproject. Make sure not to redefine uninstall targets if they are already defined. Add a --shorter-paths setup.py option, which would be used by the Windows CI, to circumvent creating paths that are too long, and thus avoiding build issues. Output the build characteristics / classifiers into the generated build_history/YYYY-MM-DD_AAAAAA/build_dir.txt file, so it can be used by the test runner to properly filter out blacklisted tests. This was necessary due to the shorter paths options. Fix various issues regarding target includes and library dependencies. Remove certain duplicated cmake code (like limited api check and build type checks) in PySide2, given that that information will now be present in the exported shiboken2 config file. Include a short README.cmake.md file that describes how to build the super project. References used https://rix0r.nl/blog/2015/08/13/cmake-guide/ https://pabloariasal.github.io/2018/02/19/its-time-to-do-cmake-right/ https://gist.github.com/mbinna/c61dbb39bca0e4fb7d1f73b0d66a4fd1 https://cliutils.gitlab.io/modern-cmake/chapters/basics/functions.html https://cmake.org/cmake/help/v3.0/manual/cmake-packages.7.html https://github.com/ComicSansMS/libstratcom/blob/master/CMakeLists.txt Abandoned approach using ExternalProject references: https://cmake.org/cmake/help/latest/module/ExternalProject.html https://stackoverflow.com/questions/44990964/how-to-perform-cmakefind-package-at-build-stage-only Fixes: PYSIDE-919 Change-Id: Iaa15d20b279a04c5e16ce2795d03f912bc44a389 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Doc: Add the data visualization tutorialVenugopal Shivashankar2019-02-0428-0/+1618
|/ | | | | | Change-Id: I17c6b4a4fa35e5b2ced79b47eaba99b393059406 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add \nullptr macro definitionFriedemann Kleint2019-01-101-0/+2
| | | | | | | Task-number: PYSIDE-903 Change-Id: I727b861b048c48bbeea51272e607c06dfb58c1df Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Update and fix the Slot documentationCristian Maureira-Fredes2019-01-101-15/+15
| | | | | | Task-number: PYSIDE-691 Change-Id: I5a6691554b64b808591e3ed000f01ca0211167ab Reviewed-by: Christian Tismer <tismer@stackless.com>
* Doc: Reduce module list duplicationVenugopal Shivashankar2018-12-262-29/+0
| | | | | | | | This would avoid unnecessary maintenance work updating the modules list in several places. Change-Id: I13466ada3568c45391a7c35f287cc11c2ad218a5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add a link to the known issues wiki pageVenugopal Shivashankar2018-12-121-9/+10
| | | | | | | | | | | | The wiki page describes some known issues and considerations that are useful to the developers. Also, moved toctree to the top to get readers' attention, as the modules list is too long. Change-Id: Id2dcce1fe51c2c9e9eacb45e573605cc21d3a59d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Add an index page for ShibokenVenugopal Shivashankar2018-11-301-2/+1
| | | | | | | | Also document the samplebinding example. Change-Id: I2ee1fa6049ae672f5ab46df4d1eba411e69dc3c7 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Remove TP from doc titleCristian Maureira-Fredes2018-11-291-1/+1
| | | | | Change-Id: I8d3fcc977b23f9efc20d9f3e073ad79f215769c0 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Update the apidoc cmake step to copy shiboken doc htmlsVenugopal Shivashankar2018-11-152-2/+11
| | | | | | | | | This way it is easier to publish the docs online as well as package it for offline use. Besides, updated the links to the sphinx projects so that the linking between them works. Change-Id: Id7494d5bc8adf95bfaaf25dedb58f3b07ac6dca4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add tutorials to the documentationCristian Maureira-Fredes2018-11-056-0/+497
| | | | | | | | Included basic tutorials related to Widgets, QML and UI files. Task-number: PYSIDE-841 Change-Id: Ia338f8cf1a64e4f09617fb3ac5a898d28e527dbd Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Update documentationCristian Maureira-Fredes2018-10-194-20/+23
| | | | | | | | | A couple of comments were outdated, and there was mixed information related to PySide, PySide2 and Qt for Python. Task-number: PYSIDE-691 Change-Id: I34c17822fc09e9027ee1c0a082ed9a27a5154996 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Merge remote-tracking branch 'origin/5.11' into devFriedemann Kleint2018-09-073-6/+2
|\ | | | | | | Change-Id: I81270510e3a27915781a50769bb627e666970142
| * Doc: Remove redundant .qdocconf files from the buildTopi Reinio2018-09-053-6/+2
| | | | | | | | | | | | | | | | | | | | | | | | QtMultimedia, QtWebEngine modules are handled with a single .qdocconf file in Qt 5. There's no need to feed them twice to QDoc. This removes most '(qdoc): Output file already exists' warnings. Change-Id: If250c9c56f7ca54c27440badd66d9ddba704f26d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Doc: Change the snippet file extensionsVenugopal Shivashankar2018-08-2915-0/+0
|/ | | | | | | | | | | The filename should be the same for the references in the documentation to work, but extension can change to py instead of cpp. Task-number: PYSIDE-691 Change-Id: Idca54292c67a32cdc2060314fe985bbd26f25d2f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Remove third-pary license text and link to the Qt licenses pageVenugopal Shivashankar2018-08-063-36/+5
| | | | | | | | | | | | This avoids duplicating license information for third-party sources used by Qt. The lincence info. for such sources are listed in the Qt documentation, so a link to it from the Qt for Python doc is a better alternative. Task-number: PYSIDE-758 Change-Id: I4efd0b2b8cce5dd76ddc98c80d1ac5cd385c7398 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add snippet override for QQuickViewVenugopal Shivashankar2018-07-191-0/+67
| | | | | Change-Id: I051ddcc61904f293ed0f21173e040f8c89e2232e Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Remove repetitive text in the licenses pageVenugopal Shivashankar2018-07-191-4/+0
| | | | | Change-Id: Ide68c9045413f26ad7d7fc781aef03d61ea99179 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add doc config for the QtQml moduleVenugopal Shivashankar2018-07-101-0/+5
| | | | | | | | This enables qdoc to include the content from the QtQml module page. Change-Id: I889e7918ae33cdc7d11f08a7e68a97c123fa05cc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add the snippets for QtUiTools and QtChartsVenugopal Shivashankar2018-06-292-0/+96
| | | | | Change-Id: I13d72daba91e608ede9498b04044bf048834f321 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Update doc config to enable conditional exclusionVenugopal Shivashankar2018-06-281-0/+3
| | | | | | | | | | This should help excluding parts of qt documentation that are not relevant for Qt for Python. For example, the \snippet entries that include qmake project file statements. Change-Id: Iec05be72b1400ecb61a109688aaa9e3bf19e95b5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Doc: Fix typos and minor editsVenugopal Shivashankar2018-06-252-4/+4
| | | | | | | | In addition, scaled down the app screenshot. Change-Id: I9edf9bf6dc3c2f4e81097feaccaa266498776a6f Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add the missing snippet filesVenugopal Shivashankar2018-06-2213-0/+689
| | | | | Change-Id: I83b66d2aa7a9e607d458f22b2ef6fc25e4abe944 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Merge branch '5.9' into 5.11Alexandru Croitor2018-06-081-1/+1
|\ | | | | | | Change-Id: I7e55b4f27f77e2333b9e0f4cddc8de4b89b6043b
| * Doc: Fix typo in the code snippet for QQuickImageProvider5.9Venugopal Shivashankar2018-06-081-1/+1
| | | | | | | | | | Change-Id: I2af23226c93706c0c18f07ce4cf59e362b170997 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* | Merge branch '5.9' into 5.11Alexandru Croitor2018-06-078-6/+90
|\| | | | | | | Change-Id: I2de0fe8456fca242c56ea28520126f9ebbf540d8
| * Doc: Include webengine module docsVenugopal Shivashankar2018-06-053-0/+10
| | | | | | | | | | Change-Id: I9ea0bed7709265c89e1bf38624024e61ee07adc7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| * Doc: Update the html_title and download.qt.io URLVenugopal Shivashankar2018-06-012-2/+2
| | | | | | | | | | Change-Id: I9b923d6fefbfae4efcf63f7459cf1ee89fb08f19 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| * Doc: Document the tabbed browser demoVenugopal Shivashankar2018-06-014-4/+78
| | | | | | | | | | | | | | | | | | | | | | | | | | - Added docstrings to the examples sources to autogenerate the docs for the different parts. - Updated the conf.py.in to include sphinx.ext.viewcode to generate html for every source file of the example. Change-Id: I668c55070556ca49d12d38c8ec83f09313bffc36 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> 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-06-011-37/+28
|\| | | | | | | Change-Id: I31a0ff26bc02e6cc2ec2a816c16d170fc334f800
| * Fix qtattributionsscannertorst.pyFriedemann Kleint2018-05-291-37/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The tool was originally written to handle a license embedded in a Python file. This has changed, the license now exists as a text file. Rewrite the tool to concatenate the output piece-wise instead of using fixed formats to be able to cope with missing URLs and versions. Add the copyrights, which were previously missing. Task-number: PSYIDE-363 Change-Id: I5ec0bd7a4b81e9f794f56f6b2b09062c331936ae Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.11Friedemann Kleint2018-05-293-3/+13
|\| | | | | | | Change-Id: I4b6ef2bcc91c46b3084f9797c1bbfaddc4367941
| * Documentation: Fix some oversights in the index pageFriedemann Kleint2018-05-281-2/+2
| | | | | | | | | | | | Task-number: PYSIDE-363 Change-Id: Ib0bc82733932eb96f9d2ca42649d28bc600d8f60 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Documentation: Fix Qt11ExtrasFriedemann Kleint2018-05-281-1/+6
| | | | | | | | | | | | | | | | | | | | Work around the non-standard header naming of the module in the documentation generation (see also file sources/pyside2/PySide2/QtX11Extras/QtX11Extras_global.post.h.in). Task-number: PYSIDE-363 Change-Id: I3ff8bb666513a13fde4d13693fd06bdd7866e050 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Documentation: Add QtMultimediaWidgetsFriedemann Kleint2018-05-282-0/+5
| | | | | | | | | | | | | | | | | | They share the qdoc.conf file with QtMultimedia, which needs to be special-cased, similar to QQuickWidgets. Task-number: PYSIDE-363 Change-Id: I5abade0a715ff3245be2322eae42e7c93f643fc9 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.11Friedemann Kleint2018-05-264-122/+6
|\| | | | | | | Change-Id: I0c5b60263ed642a9b6f6b5d6a1492a11f278bfd5
| * Add QtScxml to the documentationFriedemann Kleint2018-05-252-1/+5
| | | | | | | | | | | | | | | | Complements 9d10897929350417f4c7b2dcf06966ff7c67c5a6. Task-number: PYSIDE-487 Change-Id: I4a01c986535c0d7ba8362760c1b8e89a2f8e9936 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Remove left-over documentation filesFriedemann Kleint2018-05-251-120/+0
| | | | | | | | | | | | | | - _templates/index.html Change-Id: Idcde052a1a77e2ade1de712db79da95d5ed6c02c Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Doc: Use relative path to the shiboken docsVenugopal Shivashankar2018-05-251-1/+1
| | | | | | | | | | Change-Id: I63e3d87a62932e20ce28bf344636c05a61f1c6b0 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.11Friedemann Kleint2018-05-186-18/+15
|\| | | | | | | Change-Id: I20cf741f5b07426ad5113eb8c52f144102c331ce
| * Update Logo to the "Qt for Python" logo, 400x94Friedemann Kleint2018-05-162-1/+1
| | | | | | | | | | | | | | | | | | Adapt the layout template accordingly. Task-number: PYSIDE-363 Change-Id: Iea3b50770acf908f04fcfbd39d178de33c247c01 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Make it possible to specify a target directory for additional documentationFriedemann Kleint2018-05-161-0/+2
| | | | | | | | | | | | | | | | | | Introduce a simple [] notation for target directories. Task-number: PYSIDE-363 Change-Id: I3a0cd255faf84f564a64992cba88244ae14c2452 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
| * Doc: Add a link to the shiboken docsVenugopal Shivashankar2018-05-143-17/+12
| | | | | | | | | | | | | | | | Also reorganized the toctree structure by removing the sections. Change-Id: I6d3bbc363b86d07cc05fd3b7391b3f8b0de3605c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.11Friedemann Kleint2018-05-091-1/+1
|\| | | | | | | Change-Id: Ic7aa7796dffda87ef492a99af7859c909ec607a2
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-18 07:11:54 +0000