aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* | pyside2: Prepare build system for Qt 6Friedemann Kleint2020-05-181-3/+3
| | | | | | | | | | | | | | | | | | | | | | - Introduce a version variable to the CMakeLists. - Emulate the Qt5Core_INCLUDE_DIRS, Qt5Core_LIBRARIES variables by retrieving them from the INTERFACE - Raise the language level Task-number: PYSIDE-904 Change-Id: Ie4e43e7e6a9a2631d666038b80f306e2d9af47b1 Reviewed-by: Christian Tismer <tismer@stackless.com>
* | doc: add more videos from Qt eventsCristian Maureira-Fredes2020-05-171-1/+66
|/ | | | | | Task-number: PYSIDE-841 Change-Id: I1d64fe659a7651a4da2f537368d19d731d5c1e54 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Adapt UI files tutorial to newly added UiLoader exampleFriedemann Kleint2020-04-031-3/+8
| | | | | | | | Amends cf8e0d98821cc7e6f0fc48b56a0a16ad88cd881b. Task-number: PYSIDE-841 Change-Id: Iea6ab04e2ce8c4fb77d7d5c770dc45005f2635dc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add clarification to examples pageCristian Maureira-Fredes2020-03-301-1/+6
| | | | | | | | | | New users are getting confused by the phrasing of the page, and believe we only have two examples in our codebase. Adding a paragraph to clarify this situation will solve the misconception. Change-Id: I2a18d99771eee82af3181a997c137109840edbec Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add some qApp documentationChristian Tismer2020-02-271-1/+51
| | | | | | | Updated to the new simple builtin variable. Change-Id: I918ce7bc9aea6451439a8306d5bbd325c04e8136 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: Add information about internal toolsCristián Maureira-Fredes2020-02-261-5/+53
| | | | | Change-Id: I1d814b72359e188ba8263b0cb583ccb43af5e4b4 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix grammar in considerations.rstChristian Tismer2020-01-291-2/+2
| | | | | Change-Id: I7d840367d9a733d925bbfeb78a0ba0c9c076e6c0 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* docs: QML and SQL integration tutorialMariana Meireles2020-01-276-0/+598
| | | | | Change-Id: I6ba4ae9fe6a9bfe669b76a23f27556b1f3c59eb4 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* docs: More fixes on deployment and faqKavindra Palaraja2020-01-274-62/+86
| | | | | Change-Id: I97d7251b0d9ec024ce069f6475d7bc6be0d9d362 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* docs: Fix pre overlap and improve readingCristián Maureira-Fredes2020-01-241-2/+1
| | | | | | | | | | | | | Removed the color and the padding on the 'pre' elements of the docs. Additionally increased the line-height globally to 1.4 to make the reading easy. Fixes: PYSIDE-1201 Change-Id: I292d4e6da616ecb84a923444b99ad28a28d6cc5d Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update toctree to include only the module indexVenugopal Shivashankar2020-01-051-1/+1
| | | | | | | | | | The index adds all the class reference docs to the toctree so we don't need to include everything under the module directory. Change-Id: I6ef20914a63a1f246b06b2725435a4fc42deaf9b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* docs: Propose new structure for API indexKavindra Palaraja2020-01-022-37/+59
| | | | | Change-Id: If2d96afbf93f153fb1b8e79f150a934620899d18 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Document the Property function in QtCoreVenugopal Shivashankar2019-12-121-0/+62
| | | | | | | | The content for this lived on the wiki till now. Change-Id: I3e6a2cb7f97ab7021621b7c687299a3199134bb5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Fix warnings about link targets and indentationVenugopal Shivashankar2019-12-0611-33/+58
| | | | | | | | | Also ensured that all the doc entities are in the toctree so that the navigation breadcrumb is generated. Change-Id: If993cca4c7e91723fa373d3453196bcfee9f3ffa Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: Simplify the Quick Start topicKavindra Palaraja2019-12-042-23/+19
| | | | | Change-Id: I11651033783052591f38cd8eb02ec47719c91dbf Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* New documentation structureCristián Maureira-Fredes2019-12-0321-634/+841
| | | | | | | | | | | | | | | | - New structure for the landing page, - Some rst were renamed to the new structure, - New sections "Videos", "Examples" and "Getting Started" were created, - Information from the wiki was used to create the Getting Started sections, - FAQ section was removed, - Removing pyhtml2devhelp.py since it is unused, - The new CSS modifications were copied over the Shiboken2 directory. Task-number: PYSIDE-1067 Change-Id: I1ba53cd0030d6d02449fecdfea70efb49421ad3b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com>
* docs: Propose new structure for overviewKavindra Palaraja2019-11-271-36/+4
| | | | | Change-Id: I4a946cc0373f986db422439b1796fdddbf0ae35b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: Clean up the PyInstaller topicKavindra Palaraja2019-11-271-66/+50
| | | | | Change-Id: I0d0668fd4270d58f2ab50bd14c9d7100ff906d3c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Drop PySide prefix from the RST filenamesVenugopal Shivashankar2019-11-1819-4/+4
| | | | | | | | | | | | | | | Shiboken appends the content in these RSTs to the module index pages that it generates. In addition, - updated the snippets, extras, and additional docs passed to the Shiboken call. - moved the copy_directory command right before the shiboken call. Change-Id: I45222ba7d0798105a764d7692d466f7a2a105d77 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Fix sphinx warnings about indentation and linkingVenugopal Shivashankar2019-11-0111-118/+149
| | | | | | Change-Id: I22fc8b60d9c9209224eddbd8255f8e2b834da0ae Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Use the exclude_patterns instead of exclude_treesVenugopal Shivashankar2019-10-281-1/+1
| | | | | | | | | | The extras directory should be ignored by sphinx, otherwise we'll have duplicate module pages. The exclude_trees sphinx config is deprecated since the v1.0 release. The alternative for it is the exclude_patterns. Change-Id: I2fa8a0c3d8080bc838397091dfad950a97aa697e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Add the additional and the API ref pages to the toctreeVenugopal Shivashankar2019-10-254-54/+76
| | | | | | | | | The breadcrumb does not work as expected without these pages in the toctree. In addition, changed the module page links to use the :mod: directive instead of the :doc:. Change-Id: I0fc86ae0026375d4924b870c5e20c504aea3aed1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Minor fixes to the snippets and their orderVenugopal Shivashankar2019-10-163-2/+4
| | | | | Change-Id: Idf0bc429373180bf4c512014255eb7f6c93bd891 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Fix the broken download linksVenugopal Shivashankar2019-10-151-2/+2
| | | | | | | The links were using the the wrong directive. Change-Id: I3bbb3262d96857b66fff7d273f475514f880cb7c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Set up necessary infra. for example doc generationVenugopal Shivashankar2019-10-159-1/+144
| | | | | | | | | 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>
* Doc: Add Porting guide tutorialVenugopal Shivashankar2019-10-1529-0/+2443
| | | | | | | | | Moving the content from this wiki page: https://wiki.qt.io/Qt_for_Python/Porting_guide Change-Id: Ic4ad03ccd5b65bdf08e27dbf045fe7528ec6cdb4 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Fix formatting of the deployment documentationFriedemann Kleint2019-09-111-5/+5
| | | | | | | | Fix wrapping and bullet list. Fixes: PYSIDE-1089 Change-Id: Ibf4c7f6ccb5b167da6ccb4afa9cc2c51d0551c78 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Improve the documentation styleTopi Reinio2019-09-021-20/+76
| | | | | | | | | | | | | | | | | | | - Restyle the admonition (warning/note/seealso) paragraphs, use the same font for all link types, and separate entries with ', '. - Drop the rounded corners on multiple section titles. - Use a monospace font for enumeration tables (value column). - Restyle the <blockquote> element that is used for overload/parameter docs to separate them from the documentation 'body'. - Replace list-style-type:'' with list-style:none as the former does not work on all browsers. Change-Id: I0c37bd05448d7ce38a47af7449ca0bc9efff68b4 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Docs: Add missing pysideversion codeCristián Maureira-Fredes2019-08-201-4/+18
| | | | | | | | | The file pysideversion was removed, but the Getting Started page was still referencing it. This change add the code that used to be in pysideversion.rst Change-Id: Ie80b2cd95cac6f50e52be2556d53de209422f26e Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Update docs styleCristián Maureira-Fredes2019-08-201-12/+79
| | | | | | | | | | | | | | Some upgrades to improve the readability: * Reduce margins, * Remove round-corners from boxes, * Remove parameters and return type boxes and use bold instead, * Always show the Table of Contents. Task-number: PYSIDE-1067 Change-Id: Ibaa484172103eff17426ae03ee6f95c78fe51143 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Documentation: update QInputDialog snippetsCristián Maureira-Fredes2019-08-141-12/+12
| | | | | | | | | | Adapting the code, since we return a tuple (retval, ok) instead of the Qt/C++ approach of having the boolean ok as a parameter. Task-number: PYSIDE-1059 Change-Id: Ied9f99048b95c034850111135ba47ff3aad34917 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-06-26207-23560/+0
|\ | | | | | | Change-Id: I5bfa45782938d3bf43e16164f1ecd69f53bfcf8e
| * Remove left-over C++ example snippetsFriedemann Kleint2019-06-25207-23560/+0
| | | | | | | | | | | | Change-Id: I15d5c647e68344ae4a05898be6d8a334cf25f3b4 Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Doc: Fix minor issuesVenugopal Shivashankar2019-06-193-6/+8
| | | | | | | | | | | | | | | | | | - Removed links to old qml tutorials - Fixed a note with overflowing text - Fixed the order of chapters list in a tutorial Change-Id: Ic42c35271dd161235ed8b08f596100e104f6139e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Doc: Fix typoVenugopal Shivashankar2019-06-131-1/+1
| | | | | | | | | | | | | | | | Change-Id: I1aebb1c1b680e92506274033285807d21c7b862b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Example: Move the SQL statementsVenugopal Shivashankar2019-06-181-29/+22
| | | | | | | | | | | | | | | | | | | | | | Moving the SQL statements into separate variables outside the scope of the 'init_db' function, improves readability. Change-Id: I716dfceef6dc343287afab17f74e8de7fae618c6 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Doc: Minor language editsVenugopal Shivashankar2019-06-123-71/+76
| | | | | | | | | | | | | | | | | | - reordered a few sentences - removed a few redundant bits Change-Id: I111dc51b7912a056ec8d9dc3bc765e9d374b6060 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Doc: add official CSSCristián Maureira-Fredes2019-05-093-478/+1893
| | | | | | | | | | | | | | | | | | This is the CSS that the official web is using, and replace the old PySide1 style when building locally. Change-Id: Ibc78f52913a108b804cc2472f312c34c962635a9 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Docs: Add Expenses tool tutorialCristian Maureira-Fredes2019-05-2714-0/+1803
| | | | | | | | | | | | | | | | | | Tutorial based on QTableWidget, QPushButton, and QChartView to create an application to keep track of expenses. Task-number: PYSIDE-841 Change-Id: Ia8527a7e7f6c234fad641bbd91006af1812d5975 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-05-201-0/+49
|\| | | | | | | Change-Id: I36594dc6d6f5f56656d1cab2b1e9c44b57e56386
| * Add Some Hints For Dealing With PyInstallerChristian Tismer2019-05-141-0/+49
| | | | | | | | | | | | | | | | | | | | | | | | PyInstaller has a bug when multiple versions are installed. There are also some other traps which can give additional trouble. The "--reuse-build" problems have vanished meanwhile and were removed. The numpy problem with Python 2.7.16 was added. Change-Id: I6c60d8ee823963b59fc6b65a6ab8007314e4098c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Update deployment docs for fbs 0.7.6Michael Herrmann2019-05-092-17/+13
| | | | | | | | | | Change-Id: I92054ee657899960f9efd2056ab7851a3fe21fe6 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-04-2411-8/+456
|\| | | | | | | Change-Id: I28805a29caa05e996b490ba46e27ddbc243cc074
| * Tutorials: Fix some sphinx warnings about unexpected indentationFriedemann Kleint2019-04-245-2/+23
| | | | | | | | | | Change-Id: I1415417ab761c57e64c0f031a9b63b5f85c9c7c7 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| * Remove copy for non-existing ApiExtractor docsCristián Maureira-Fredes2019-04-151-6/+2
| | | | | | | | | | Change-Id: I45998473fe82c1affbf0d88b1e0d38a95795cfa5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| * Doc: Add tutorials related to deploymentCristian Maureira-Fredes2019-04-045-0/+431
| | | | | | | | | | | | | | | | | | | | Including in the documentation a section related to deployment, and also tutorials associated to the following tools: PyInstaller, cx_Freeze, and fbs. Task-number: PYSIDE-901 Change-Id: I6162b039b5df3eced38ce65fe7cb143be9f0de82 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* | Doc: Add QML Integration tutorialCristian Maureira-Fredes2019-04-038-0/+423
| | | | | | | | | | | | | | | | | | | | Since the qmlapp tutorial already explain many things related to QML and PySide2 interaction, I made this shorter highlighting only a few things. Task-number: PYSIDE-841 Change-Id: I4a4618605a1868cf3632cf0efbafcfc4566b4257 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Docs: Remove QML tutorialsCristian Maureira-Fredes2019-04-0258-3003/+0
| | | | | | | | | | | | | | | | | | Since these old tutorials are only QML-oriented, it does not contribute with the Qt for Python documentation. Change-Id: Ic3acd170521e2395486cbbb03f210a644f556130 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-04-027-94/+271
|\| | | | | | | Change-Id: I7fc1857f15ccf5d9667dd6d6adb8208c775c6722
| * Doc: Add descriptions, pages, and moving modulesCristian Maureira-Fredes2019-03-275-92/+255
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Having all the Qt modules on the main page is too verbose. I created four sections with a couple of them and added more context to clarify when to use them. All the modules are still listed in a new page called `modules`. I included an `overview` page with some general information from our wiki: compatibility among platforms, an example and the FAQ. Task-number: PYSIDE-691 Change-Id: Ic9e2519aa2caa9c8a645633c2c1772e4844b5ec5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-03 10:26:26 +0000