aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/conf.py.in
Commit message (Collapse)AuthorAgeFilesLines
* Rename PySide2 to PySide6Friedemann Kleint2020-11-021-190/+0
| | | | | | | | Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Rename shiboken2 to shiboken6Friedemann Kleint2020-10-281-2/+2
| | | | | | | | Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I4cb5ee4c8df539546014b08202a7b1e98ed3ff07 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add command to build rst documentation onlyCristian Maureira-Fredes2020-09-291-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | Since the process to get the documentation built is to build the whole project, that is too time consuming. Additionally, using qdoc on the Qt API takes a lot of time. This patch introduces the setup.py option called 'build_rst_docs' which skip the general build, and only generates HTML documentation based on all the .rst files we have for shiboken and pyside. To use it: python setup.py build_rst_docs The build will throw warnings related missing directories, and files, which are generated on the 'qdoc' process, but since they are skipped they are not present. Some missing references warnings are skipped due to also come from the qdoc-based step. Task-number: PYSIDE-1106 Fixes: PYSIDE-1390 Change-Id: I4118fd3b64e217717df6cae093138f6951d37094 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Enable doc builds using the offline templateVenugopal Shivashankar2020-06-041-1/+10
| | | | | | | | | | A new command-line option, --doc-build-online, enables to choose online builds, otherwise offline docs are built by default. Change-Id: I34ef8a22ef3bd321bd972c4f2873e4321c9c336a Fixes: PYSIDE-1292 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@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>
* 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-121-1/+2
| | | | | | | | | 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>
* 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-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>
* Doc: Update the html_title and download.qt.io URLVenugopal Shivashankar2018-06-011-1/+1
| | | | | Change-Id: I9b923d6fefbfae4efcf63f7459cf1ee89fb08f19 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Document the tabbed browser demoVenugopal Shivashankar2018-06-011-1/+3
| | | | | | | | | | | | | - 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>
* Doc: Use relative path to the shiboken docsVenugopal Shivashankar2018-05-251-1/+1
| | | | | Change-Id: I63e3d87a62932e20ce28bf344636c05a61f1c6b0 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add a link to the shiboken docsVenugopal Shivashankar2018-05-141-1/+8
| | | | | | | | 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>
* Doc: Use product name and python module names appropriatelyVenugopal Shivashankar2018-04-301-1/+2
| | | | | | | | | Configured replaceable text entities so that updating instances of product and module names in the doc is less cumbersome. Change-Id: I6ef8adcc4324775eeb8a48bf81294effb0ea12d5 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add top-level index and getting started informationVenugopal Shivashankar2018-04-271-5/+4
| | | | | | | | | - 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>
* 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/pyside2 (5.9 edition)Oswald Buddenhagen2017-05-221-0/+169
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 2025-12-18 21:28:37 +0000