Commit Graph

16 Commits

Author SHA1 Message Date
Eike Ziller
eaa40953af Fix framework path for developer documentation build on macOS
At some point the LOCATION target property of Qt::Core must have changed
from
    <fw_path>/QtCore.framework/QtCore
to
    <fw_path>/QtCore.framework/Versions/A/QtCore
which broke the code that tried to infer the `fw_path` from it.
Instead of constructing a relative path from the LOCATION, just
cut off the `/QtCore.framework/` and anything after it.

Change-Id: Ieed8ade6318c602d9cb4ff9685a084e4f8194086
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-07-05 07:36:50 +00:00
Eike Ziller
14ef6da101 Fix developer documentation build with Qt >= 6.8 on macOS
Before Qt 6.8, the versionnumber-less targets of Qt were interface
libraries that linked to the actual versioned Qt target. Since then,
they are actual targets in their own right, so the code that determined
the header location for Qt on macOS failed.

Change-Id: Icb2d2fcb075b9b4c2808d7edc0a7ec3fb7be49f7
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-07-05 07:36:42 +00:00
Marco Bubke
dd962c2989 Docs: Add option to build docs by default
Change-Id: I6cb8c2b163f5d01040952aecced287334d616976
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-19 09:01:02 +00:00
Eike Ziller
65fcb9b746 Help: Update litehtml to v0.9
And adapt the attributions to use the attribution.json from the
qlitehtml repository, so it is automatically in sync.

Fixes: QTCREATORBUG-29169
Change-Id: I96343162880b6aa0e38ee356b3b5f98db4a85cc3
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-02-15 07:02:23 +00:00
Eike Ziller
9954a285f2 Doc: Fix insource build
When implementing acknowledgments via the generated attributions file,
the complete `<qtc_build>/doc/` directory was added as a source
directory for qdoc. For insource builds the build directory is the same
as the source directory, so qdoc would suddenly include all
documentation from `<qtc_source>/doc/`, which mixes Design Studio and Qt
Creator documentation.

Move the generated attributions file into a subdirectory, and only add
that subdirectory. Also fix that attributions were not generated at all
anymore after trying to fix issues when qdoc is missing.

Amends 2ce9f9d97d and
13b48144a6

Change-Id: I689827dabca37c81d4351dec04f23f46503429f6
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-01-08 11:18:53 +00:00
Eike Ziller
2ce9f9d97d Move most acknowledgments to qt_attributions.json
Create a qt_attributions.json and generate a documentation file from it
automatically when building documentation. The result is included as a
table in the acknowledgments page in the documentation.

Some attributions cannot (yet) move to qt_attributions.json, because
that requires the sources to be available in the project's source tree,
which is not the case for LLVM, Clazy, etc.

Remove the attributions from the README and instead point to the
documentation from there, so we get rid of that duplication.

Change-Id: I22623fe7495593ffce2e2c6c26255c27c5a8cb71
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-12-15 09:02:23 +00:00
Eike Ziller
55fa109b59 CMake build: Use version-less Qt targets
Since we do not support Qt < 5.15 anymore, and as a first step
for getting rid of our special FindQt5.cmake.

Change-Id: Icc5dbaf9b0a3a622b1f609ff114b9decb6d2856c
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-01-05 10:13:16 +00:00
Eike Ziller
4b3a746332 CMake build: Fix remaining issues with Devel package
On Linux (and Windows) we should not create toplevel files (README.md
etc) or directories (doc/, scripts/ etc).

On macOS, move the whole Devel package contents into the app bundle,
because that is installed toplevel in the Qt installers, and we
shouldn't even create include/, lib/ or any other directory at the
toplevel at all.

Since the prefix path must now point to the Resources folder inside the
app bundle, adapt build_plugin.py to also accept --qtc-path pointing to
the app bundle (Qt Creator.app) itself, and also to the app bundles
parent directory. Adapt the Qt Creator plugin project template
similarly.

Task-number: QTCREATORBUG-25414
Fixes: QTCREATORBUG-25415
Change-Id: Ic756237fb920b54b1ec95d076649ad947b39a7e8
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-04-06 10:59:27 +00:00
Eike Ziller
240fba0222 cmake build: Allow branding to change documentation file
Task-number: QTCREATORBUG-22488
Change-Id: I80a1feafa7b027dc99acdb019359037ae0259573
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-10-28 08:53:23 +00:00
Eike Ziller
b3ffd8d1eb CMake build: Move documentation functions to re-usable location
Removes "install_..._docs" and "clean_docs" special targets.
Instead install documentation with "--install . --component qch_docs"
and "--install . --component html_docs" which have the advantage that
the install prefix can be specified later on with --prefix.
Also removes export of IDE_SOURCE_DIR, which is not used.

Change-Id: I4fce0b9aa8c7fc40b7e94e065777ddf4c0b76c41
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-05-25 11:31:06 +00:00
Eike Ziller
0acce09457 cmake build: Fix qdoc call for LLVM-based qdoc
It requires us to pass a whole bunch of include paths manually,
including Qt include paths.

Extracts a stripped down list of include paths from all the plugin and
library targets that we know of.
On macOS, also gets Qt's framework path derived from the QtCore location.

Since these can contain generator expressions, we have to write them to
a file (so the expressions are resolved).
We pass this file with qdoc options with the hidden "@" command line
feature of qdoc.

Task-number: QTCREATORBUG-22451
Change-Id: Ifae6960023cc6e63cd66104417dd4a16f2e491a2
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-02-26 06:42:51 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00
Eike Ziller
382589f160 CMake build: Fix output location for qch files
Change-Id: I8722ca02f6e7f5c97f3d29ba6d69a752d1cbdd5f
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-01-13 14:47:59 +00:00
Tobias Hunger
71ab4a83c2 CMake: Use Qt5::qhelpgenerator target
I missed that before, but it is actually there:-)

Change-Id: Ifaeaba4aa524980328cb68a8a039ff58e4b74ed8
Reviewed-by: Volker Krause <volker.krause@kdab.com>
2019-06-04 07:40:19 +00:00
Tobias Hunger
e4ce57fb92 CMake: Fix typo in docs/CMakeLists.txt
Change-Id: I4fb900c5d43b6ac2847335ba90fce013741c0c42
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2019-05-21 11:42:04 +00:00
Tobias Hunger
e3df930886 CMake: add docs, clean_docs and install_docs targets
Change-Id: Ic9883f0fc8c85db4573e751261cf347e56777a3a
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-21 09:56:49 +00:00