aboutsummaryrefslogtreecommitdiffstats
path: root/README.shiboken2-generator.md
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2020-09-26 21:11:16 +0200
committerCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2020-09-29 20:34:54 +0200
commitff792fd2e6842b990aff61a4e953dab5efbd89ae (patch)
tree4e51f0d864fbefabe1bcb6c074e345b393dceaa2 /README.shiboken2-generator.md
parent510bc5b2cf2196d31e950f16d5cfcf6ee1238f47 (diff)
Add command to build rst documentation only
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>
Diffstat (limited to 'README.shiboken2-generator.md')
0 files changed, 0 insertions, 0 deletions