Commit Graph

21 Commits

Author SHA1 Message Date
Leena Miettinen
bcd3491fd9 Doc: Update front page and getting started page
Apply new design and images from the UX team.

Task-number: QTCREATORBUG-30248
Change-Id: I202288f0dccedc65e47cd8bdfa49915d47cd79cd
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-04 10:48:11 +00:00
Leena Miettinen
fadfb93b8e Doc: Fix broken links
- Add a dependency to qtqmltest (Qt Quick Test)
- Fix an internal link
- Fix capitalization in links to Qt docs, which now
  seems to matter
- Add the "Qt Qml" link as an external resource, so it works
  regardless of the Qt version used

Change-Id: I0550973237b0df7b328ca202a4188d970af3417d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-19 10:58:21 +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
Leena Miettinen
4ca57ffd87 Doc: Add qtquickcontrols as a dependency
...to fix a broken link to Button docs.

Change-Id: Ie40f45d5ca033a2bdb6540822d6b7124ab4529e2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-10-13 07:02:03 +00:00
Leena Miettinen
4df90c9d8c Doc: Add qtpositioning as a dependency
To fix a link to Qt Positioning.

Change-Id: I7c943c99dd1653bc033a5df9937ae8b68878997a
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2023-09-07 08:39:34 +00:00
Leena Miettinen
d70089485e Doc: Autogenerate better breadcrumbs in topics
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>
2023-06-27 11:42:31 +00:00
Leena Miettinen
659d82c499 Doc: Fix broken links when building with Qt 6
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>
2022-02-28 16:05:01 +00:00
Leena Miettinen
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- 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>
2021-12-09 10:44:55 +00:00
Leena Miettinen
60f2b81773 Doc: Fix method to ignore Boot2Qt for auto-linking
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>
2021-11-23 10:48:46 +00:00
Leena Miettinen
73fa76f776 Doc: Remove info about Qt Quick Designer plugin from Qt Creator Manual
Fixes: QTCREATORBUG-26321
Change-Id: I8738cbdc56d6469a4d133b17741871787e0cba9f
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-10-18 07:21:39 +00:00
Kai Koehne
33487984b9 Doc: Use version independent Qt link
or use direct links where possible.

Change-Id: I00d559ad53a95caf91c39985bd9fb5ea99f9aed7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-10 10:48:25 +00:00
Leena Miettinen
b9886a4b04 Doc: Fix the \youtube macro for use with liteHTML help backend
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>
2020-12-01 10:40:02 +00:00
Leena Miettinen
652feacd5f Doc: Describe Positioner and Layout type properties
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>
2020-10-28 14:04:04 +00:00
Leena Miettinen
46a9e35c28 Doc: Describe properties of Studio Components (shapes)
And the basic Rectangle.

Fixes: QDS-2848
Change-Id: I6a0f506ed1f1c0ec3d065823131e7eb48445c6e2
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-10-02 12:54:13 +00:00
Leena Miettinen
2e1eed1945 Doc: Add list to words to ignore for automatic linking
Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-09 12:45:19 +00:00
Leena Miettinen
a85e5ce618 Doc: Update information about developing for Android devices
- 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>
2020-08-11 08:16:43 +00:00
Eike Ziller
e7b319fbc1 Doc: Fix naming of .index files
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>
2020-05-25 08:50:54 +00:00
Leena Miettinen
faa8547b12 Doc: Fix links to QtAndroid functions
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>
2020-04-20 11:56:50 +00:00
Leena Miettinen
9e915ecba0 Doc: Describe Qt Quick Designer 3D editor
- 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>
2020-03-12 08:40:41 +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