aboutsummaryrefslogtreecommitdiffstats
path: root/doc/doc.qbs
Commit message (Collapse)AuthorAgeFilesLines
* cmake: Pass python3 from CMake to QbsIvan Komissarov2020-12-111-3/+3
| | | | | | | | ...to avoid fuss with possibly different Python versions found by CMake and Qbs Change-Id: I887f8aed8ed52b2766c0c1c411525b433b21458a Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Use python3 in Travis for building docs and running clang-tidyIvan Komissarov2020-02-211-1/+10
| | | | | | Change-Id: I2f0d72abdf12a4e64b79bf9a3c02b32cf4cbeed6 Reviewed-by: Richard Weickelt <richard@weickelt.de> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* doc: Add CONTRIBUTING.md fileIvan Komissarov2020-01-061-0/+1
| | | | | | | | | ...according to the GitHub contributing guidelines Change-Id: I05193a796dc3dff7251f827f0c628f47b6381a70 Reviewed-by: Richard Weickelt <richard@weickelt.de> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* doc: Provide a bit more info in the README fileIvan Komissarov2019-12-201-1/+1
| | | | | | | | | | | Qbs has a mirror on the GitHub.com and the README file is a starting point for people who come to the website. It is nice to have quick links that can be useful for newcomers. Also, rename the README file to README.md to be able to use Markdown Change-Id: I38394cf0a0802bfebebc9f070732041cfe24090c Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Introduce the session commandChristian Kandeler2019-09-181-0/+1
| | | | | | | | | | Offers a JSON-based API for interaction with other tools via stdin/ stdout. This allows for proper qbs support in IDEs that do not use Qt or even C++. Change-Id: Ib051a40b7ebe1c6e0c3147cca9bd96e7daec1fde Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Allow build of at least the html docs when cross-compilingRichard Weickelt2019-09-021-1/+3
| | | | | | | | Qch requires qhelpgenerator which is not bootstrapped, but qdoc works to some extent. Change-Id: I08ce043281c45a29829a2ec25d8ad3e38e90d4e2 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Add script to strip bogus QML import statements from the docsChristian Kandeler2017-11-291-2/+45
| | | | | | | | | | | ... and make use of it in the qbs build. Otherwise, we'd ship broken HTML files in our release packages. The script is a stripped-down version of clean-online-docs.py from the doctools repository. We also adapted it to keep the inheritance information. Change-Id: I9c6d0dcc5c11a1bc24bed3eec3ebe04908bae4f3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Allow disabling pieces of the Qbs project by categoryJake Petroules2017-11-091-44/+48
| | | | | | | | This allows the "resources build" to not rely on a valid Qt profile. Task-number: QBS-1238 Change-Id: I1c743a95993099250da714c794b6e0ac16133609 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Document how to target common platformsLeena Miettinen2017-10-231-0/+1
| | | | | | | Task-number: QBS-1183 Change-Id: I53f1a8f44f5ea727c797a8cf3c37948ac7fc3fea Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Doc: Create a CLI referenceLeena Miettinen2017-10-041-0/+1
| | | | | | | | | | | | | Each command is described on a separate page. Option and parameter descriptions are fetched from include files. \group and \ingroup commands are used to create a table that shows the CLI commands and short descriptions (from \brief commands). Task-number: QBS-947 Change-Id: I956c0e029f87e98162e03206a79baef604f1d55e Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Make sure all files in the repository are shown in the Qbs project treeJake Petroules2017-08-161-0/+6
| | | | | | | | This is helpful when working with IDEs because it enables Find functions to work better, and avoids context switching to other editors. Change-Id: I419ab440bd2b43eaf712b2cc498cc6c2d6d9e21b Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Document how to get binaries for QbsKai Koehne2017-07-241-0/+1
| | | | | | | | | | Move the section on how to build Qbs from sources to the end, and instead start with how to get precompiled Qbs binaries. This is arguably what most people prefer. Change-Id: Ibbfc7e3fcb9994840ab5d647a4846b88278deac5 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* Rename the doc productChristian Kandeler2017-07-101-1/+1
| | | | | | | | "documentation" is too generic a name when embedded into a larger project such as Qt Creator. Change-Id: I68e8710cccfaca9d295eed69a51b787fb8d01cdc Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* Documentation: Add "How-to" pageChristian Kandeler2017-06-061-0/+1
| | | | | | | | | | | | This fills a void in our documentation: Concrete, hands-on advice that is easily located. New items should be added based on feedback from our users. [ChangeLog] Added "How-to" section to documentation Change-Id: If959c9d979e18d44f6ef42810a8b0280bce64bda Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Introduce the qbsversion module for building QbsJake Petroules2017-06-021-3/+3
| | | | | | | | | | Use that instead of QbsFunctions.qbsVersion() and read it in qbs_version.pri; this has the advantage that simple text processing tools can retrieve the project version without having to parse JavaScript. It's also set from only one place now. Change-Id: Icfd2a6bf12b794b55c9ba31934a96b4483224eae Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Make the documentation embeddable in other projectsChristian Kandeler2017-03-101-2/+8
| | | | | | | | This is for the qbs build. We've already done it for qmake. Task-number: QTCREATORBUG-13124 Change-Id: I14ffd9d5184cef8378da377190107ff4496a815a Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Use BlackboxOutputArtifactTracker for qdoc.Jake Petroules2015-08-051-3/+3
| | | | | Change-Id: Ie5b2eb70cd371287820dcc180ff3e21682ae062f Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
* qbs build: Don't build documentation by default.Christian Kandeler2015-05-051-0/+1
| | | | | | | We support this now. Change-Id: Ib1b1f41129ea0526c2a80661eaaf623cfc461e5a Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* qbs build: Introduce convenience item QbsProduct.Christian Kandeler2014-10-301-3/+3
| | | | | | | | As base product for QbsApp, QbsLibrary etc. Has little functionality at the moment, but will get more soon. Change-Id: I29ac78db2ff1ba109dd09a55e7593b2beeaba741 Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* remove support for building qbs with Qt <= 5.1.0Joerg Bornemann2014-10-291-1/+1
| | | | | Change-Id: I058eedd2d9dcaad1eaac1f4407f4f698133a774b Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
* Fix files list in documentation product.Christian Kandeler2013-09-191-1/+1
| | | | | | | The wildcard was wrong. Change-Id: I290b48f7eb5f1ce26096a71026a688b3d63002ef Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Restructure the reference part of the documentation.Christian Kandeler2013-09-191-1/+1
| | | | | | | | | | It does not scale to repeat the whole contents of the reference manually in several tables of contents. Instead, make it opaque at the top-level and use the \group feature to get at least an automatic table of contents for the lowest level (items and modules at the moment). Change-Id: I80a3334a43f62481f74c21ad9d68e913c8b3098a Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Prepare qbs project files for selective inclusion.Christian Kandeler2013-07-021-2/+3
| | | | | | | | | | | | Namely: - Move product "share" into its own file. - Move version number definition into its own file. This will make it easier to pull in only parts of the sources in an aggregating project (e.g. an IDE that does not need the executables). Change-Id: I41b724fe8a0b20d957b924fe0a827263add43dce Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Fix documentation build with qbs.Christian Kandeler2013-06-121-1/+1
| | | | | | | | Apparently, the qdoc in Qt 5.1 no longer allows a relative path as the source directory. Change-Id: Ia4de7a070020ae1951affa5653dbf73475d1fed3 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Introduce Qt.core.docPath.Christian Kandeler2013-06-031-0/+1
| | | | | | | Necessary for running qdoc. Change-Id: Ib5a5aab4067b161e817a8dd6ceba986cc01941d9 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* make Depends.name and Depends.submodules case sensitiveJoerg Bornemann2013-04-171-4/+4
| | | | | | | | | Also rename modules/qt to modules/Qt and use this form consequently. Task-number: QBS-254 Change-Id: I2e994f2bc5f93d4f887e14ac224ab360c54ad029 Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
* derive version tag from project.version in doc.qbsJoerg Bornemann2013-04-101-1/+1
| | | | | | | This is working now. Change-Id: I88fecd0253281aee3b86866c6f2ba5c352cbfa88 Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
* Take documentation into account in qbs project files.Christian Kandeler2013-04-051-0/+32
Change-Id: I9e822988bc53a7cf17d1caff377570a295231b1d Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-18 11:27:16 +0000