aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-06-191-0/+7
|\ | | | | | | Change-Id: I42955abfeb1fe8b7c6443a9b334154984286b9cc
| * shiboken: Enable specifying names for a parameters of added functionsFriedemann Kleint2019-06-051-0/+7
| | | | | | | | | | | | | | | | | | | | Introduce a way to specify a name for a parameter using '@' delimiters. Fixes: PYSIDE-1017 Change-Id: I3ae505c104a64413ca2bad628d9f9d3e04bb5b88 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Doc: add official CSSCristián Maureira-Fredes2019-05-093-476/+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>
* shiboken documentation: Move TOC to index pageFriedemann Kleint2019-04-302-22/+15
| | | | | Change-Id: I0f7c6a303cb0d404c42ae96f067eece1442c4a33 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken: Enable including typesystem XML snippets via entitiesFriedemann Kleint2019-04-161-0/+24
| | | | | | | | | | | | Implement a QXmlStreamEntityResolver which resolves undeclared entities to file names in the type system include path. This is a work-around for the missing handling of standard externally parsed entities of QXmlStreamReader. Task-number: PYSIDE-955 Change-Id: I68ebae8ad465ae460c3a0eeadaef22dca2101e6c Reviewed-by: Christian Tismer <tismer@stackless.com>
* shiboken: Move the Api extractor documentation into shibokenFriedemann Kleint2019-04-0317-16/+1307
| | | | | | | | | | | | | | | | It does not really make sense to have it separately and the reference documentation is currently not accessible from the TOC. Move it over and append it to the TOC. Merge the chapters on ownership chapters (for starters, by simply concatenating). The Api extractor overview chapter is dropped as it is outdated anyways. Partially reverts 0d12d71920067be499d9237b4ad04f7f11047759. Task-number: PYSIDE-363 Change-Id: I02f6b0a4bb91fc54267fa03cefd2ac7d4049f07b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Update logoCristian Maureira-Fredes2019-03-261-0/+0
| | | | | | | | | Updating to the new project logo (128x128). optipng was ran on the images: optipng -o 7 -strip all pysidelogo.png Change-Id: I75d0ef76a7fddf957a5095d74c4c836a2c1ebe31 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* shiboken: Add option to skip deprecated functionsFriedemann Kleint2019-01-311-0/+5
| | | | | | | | | | | | | Pass the "deprecated" annotation from Clang into the meta language and reject functions based on it when the the command line option --skip-deprecated is set. By default, have Python output a deprecation warning when a deprecated function is called (which is visible when passing -Wd). Task-number: PYSIDE-487 Change-Id: Ic28d82963fde11f258b2559b562d3f24017fe98d Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Fix minor formatting and code-block issuesVenugopal Shivashankar2018-12-041-35/+38
| | | | | | | | Sphinx apparently doesn't handle XML block by default. Change-Id: I8892d96d072e718b345f444fdb7f6686c8ee14de Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add an index page for ShibokenVenugopal Shivashankar2018-11-306-4/+279
| | | | | | | | Also document the samplebinding example. Change-Id: I2ee1fa6049ae672f5ab46df4d1eba411e69dc3c7 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Update copyright statements and obsolete infoTopi Reinio2018-11-261-1/+1
| | | | | | | | | Update the copyright statements visible in Shiboken2 and ApiExtractor documentation sets. Update the name of the Qt documentation tool. Change-Id: I09726e15a6b860f2698df683138a02683596d07d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Update the apidoc cmake step to copy shiboken doc htmlsVenugopal Shivashankar2018-11-151-1/+1
| | | | | | | | | 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>
* shiboken: Add options for diff and dry-runFriedemann Kleint2018-07-231-0/+10
| | | | | | | | | Refactor and breathe life back into the existing diff/dry-run functionality of class FileOut and make it available via command line options. Change-Id: I32e1e262c0c2e8f107776923477fe9714ad295cf Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* shiboken: Update documentation of the command line optionsFriedemann Kleint2018-07-191-17/+83
| | | | | | | Task-number: PYSIDE-363 Change-Id: Ic0ef5d9cbdc15f13b540ccd9ed1275681080aa2c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add references from ApiExtractor to shiboken docCristian Maureira-Fredes2018-04-266-33/+21
| | | | | | | | | | | | | | | | | | | Including intersphinx extension allow us to link the documentation from ApiExtractor to shiboken's. ApiExtractor doc need to be build first, so we can use the inventory that sphinx create, to link it to shiboken's configuration. All the harcoded references were replaced by dynamic references. Also new labels were included to properly cross reference topics. Checked the spell on many rst files too. Task-number: PYSIDE-363 Change-Id: I11a50b1f9eee48a00a3de6f957942eb0823eba47 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Upgrade shiboken diagrams and documentationCristian Maureira-Fredes2018-04-1920-1154/+892
| | | | | | | | | | | | | | | | | Applied Qt-style to the diagrams: shapes, and colors. Removed references to Boost. Move the .rst links to the bottom of the files for better maintainability. Removed unused images and wrapped a few long lines. Aspell on the rst files. The links needs to be updated once we have the URL for the official documentation, since there are references to external documentation source directories. Task-number: PYSIDE-622 Change-Id: I2d553a29693ca4457e73a4ce5d78a2150501841d Reviewed-by: Christian Tismer <tismer@stackless.com>
* 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>
* move everying into sources/shiboken2 (5.9 edition)Oswald Buddenhagen2017-05-2239-0/+5073
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-05-06 16:29:10 +0000