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>
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>
...to fix a broken link to Button docs.
Change-Id: Ie40f45d5ca033a2bdb6540822d6b7124ab4529e2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Divide current topics into how-to and reference topics.
Task-number: QTCREATORBUG-29361
Change-Id: I0e64b2bbe9d4f6d403815dffe937a567eb9d4844
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
That is where it precedes another noun, such as "options",
"arguments", or "tools".
Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.
Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Currently, you can only get back to the front page. This
change adds the whole navigation path from the front page
to the current page, based on the lists in the All Topics
topic.
Change-Id: If0f6a6ceee70d452cec4d414a286ef093235c3de
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
And provide some tips for searching.
Task-number: QTCREATORBUG-28996
Change-Id: I35d611326555ccc568c98c49e092380d206fce6b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Some section titles have changed in Qt 6 and some
platforms and modules are not supported. Where necessary,
use fixed links to Qt 5 docs.
Fixes: QTCREATORBUG-27015
Change-Id: I469a630731f9c37deffe5ca454f5365310aaf713
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files
This is the second step towards making the icons visible in both
dark and light online doc modes.
Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Removed the backslash from \Boot2Qt, and added Boot2Qt in ignorewords
in .qdocconf file. Created explicit links to the Boot2Qt topic in
this manual where needed.
Task-number: QTCREATORBUG-26278
Change-Id: Ieac851f711d7a2cd4d7ae034c3b81ab47c5fbc11
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Create a common directory for extra image files, and move the video
thumbnails there. This folder structure is required to work around
the fact that relative image paths passed to qhp.<project>.extraFiles
are not resolved correctly when loading the generated help project.
Change-Id: Iff5583a9a318670571b7f706182723e54e0ec466
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Move positioning to a separate topic.
The information in this topic is related not only to the
Library view, but also to the Properties and Form Editor
views.
Describe the properties of the Positioner and Layout types.
Change-Id: I9d00bc9498499f52ecf49463df7f651aaecf8f0e
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
- Users can now add images to use as splash screens.
- Restructure the information to promote the automatic setup.
- Remove obsolete and duplicate information.
- Move external links to external-resources file.
Change-Id: I9578ff8615bb2a0db528f45276d16a838554b143
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Qt Creator Manual and Extending Qt Creator had the same project name,
and therefore the same index file name.
Also qdoc's "depends" configuration requires the index file to have
the same name as the directory.
Adapt the project names accordingly.
Change-Id: Ie1ec8ede360e19e3ffd5c7dbea44344f0a631f68
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Add a dependency to the Qt Android Extras module to the
doc configuration file to enable linking to the module.
Change-Id: I69271554f78a0d73fc44032f9310e9670b06961e
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
- Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor
- Add the necessary defines to link to additional Qt modules
- Use the same structure and files for the Qt Quick Designer parts
as in Qt Design Studio Manual
- Move some overviews to /doc/qtcreator folder
- Fix the TOC and the navigation links
Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
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>
