aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/modules.rst
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Doc: Fix sphinx warnings about indentation and linkingVenugopal Shivashankar2019-11-011-1/+1
| | | | | | Change-Id: I22fc8b60d9c9209224eddbd8255f8e2b834da0ae Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add the additional and the API ref pages to the toctreeVenugopal Shivashankar2019-10-251-40/+47
| | | | | | | | | 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: Add descriptions, pages, and moving modulesCristian Maureira-Fredes2019-03-271-0/+94
| | | | | | | | | | | | | | | | 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>
* Doc: Reduce module list duplicationVenugopal Shivashankar2018-12-261-28/+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 top-level index and getting started informationVenugopal Shivashankar2018-04-271-6/+13
| | | | | | | | | - 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>
* Revive PySide2 API documentationTopi Reinio2018-01-081-13/+13
| | | | | | | | | | | | | | - 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>
* move everying into sources/pyside2 (5.9 edition)Oswald Buddenhagen2017-05-221-0/+21
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.