Commit Graph

18 Commits

Author SHA1 Message Date
Leena Miettinen
e76ac2e98d Doc: Update instructions for writing Qt Creator and QDS docs
- Mention the new grouping of topics
- Mention that the TOC is now used to automatically generate
  navigation links in the Qt Creator Manual
- Link to QUIP 21 for instructions on using images
  (leave Qt Creator and QDS specific instructions and examples)
- Remove section about Qt Quick Designer docs, which are no longer
  built as part of the Qt Creator Manual
- Remove the example for configuring the docs for an external plugin
  because Fossil is now in qtcreator and Qt Application Manager will
  move there in v.13.0
- Fix broken links to Qt Creator Manual
- Add links to QDoc commands
- Add and remove screenshots
- Fix some language and style issues

Change-Id: I669a3bd5245140f6894bab3fec463766808f1b2a
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-01-08 08:37:08 +00:00
Leena Miettinen
158058ca3b Doc: Reorganize the "Designing UIs" section
- Create how-to and reference topics.
- Move the short descriptions of topics to "IDE Overview".

Task-number: QTCREATORBUG-29361
Change-Id: I11a334de6151350ce993e4135828a3eecaabf308
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-05 13:35:43 +00:00
Leena Miettinen
3f9f249c0d Doc: Add a readme.md for using recolordocsicons.py
In preparation of moving the instructions for taking screenshots
from the Extending Qt Creator Manual to a QUIP.

Change-Id: I034185e7ab4878cf36766db1e9a6b8de5d2b3fed
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-20 08:58:50 +00:00
Leena Miettinen
097cb17af4 Doc: Replace "Getting Help" with "How To"
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>
2023-09-13 06:56:53 +00:00
Eike Ziller
ea5a050c5c Merge remote-tracking branch 'origin/8.0' into 9.0
Conflicts:
	src/plugins/mcusupport/mcusupportsdk.cpp
	src/plugins/qmldesigner/components/edit3d/edit3dwidget.cpp
	src/plugins/qmldesigner/components/materialbrowser/bundleimporter.cpp
	src/plugins/qmldesigner/components/materialbrowser/materialbrowserview.cpp

Change-Id: I9317da0fc1243b9ce6d87f577aa843c51f132ad7
2022-10-18 10:48:46 +02:00
Leena Miettinen
b4d0db920a Doc: Update instructions for writing documentation
For new and updated images, use the display resolution 1920x1080.

Change-Id: Ie7a83d23eacfa8ba9b78a4de4ee9046e838fa72c
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2022-10-13 11:55:40 +00:00
Lucie Gérard
a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00
Leena Miettinen
226abd4de7 Doc: Do not use comma before "because"
Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 10:39:52 +00:00
Leena Miettinen
639a3c3b21 Doc: Describe src/tools/icons/recolordocsicons.py
Task-number: QTCREATORBUG-26644
Change-Id: Ibba0949211e0ae716ddd6974c87eaefe503b45d2
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-01-25 12:56:16 +00:00
Eike Ziller
9d8a419d10 Remove qmake build files
Removes qmake as a build system for building Qt Creator itself.
Keep them for some tests that are not completely moved to CMake yet.

Change-Id: I846c6ef65626b6dfae6375fdc85d00677aa8c2fb
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-01-20 12:18:15 +00:00
Eike Ziller
33f2074272 Bump requirement to Qt 5.15.2
Qt 5.15.2 includes API that makes transitioning to Qt 6 easier.
We currently have workarounds for Qt 5.14 in place that we can
remove when requiring 5.15.2, and we also can stop adding workarounds
for new code.

Change-Id: I920fdccc41d755a6ad39cb5161cd916999fee755
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: Robert Löhning <robert.loehning@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-01-17 10:20:32 +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
a45689f85c Doc: Update instructions for using the \youtube macro
We needed a workaround to make this work in Qt Creator
and Qt Design Studio help mode.

Change-Id: I9b66fe91a5faa07366375a886a9f99352629945d
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-12-09 14:19:23 +00:00
Leena Miettinen
0c29e50353 Doc: Describe building docs with CMake and using the online style
You can now use CMake to build docs.

You also have an option to use the online style, which
enables you to check how the docs will look after release.

Change-Id: I63f573a58a2daf3aa05a2f0dd57f33f859e25bc2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-03 11:53:24 +00:00
Leena Miettinen
bd17dd445b Doc: Add instructions for using the \youtube macro
The macro shows a thumbnail with a play button to start the
video.

Change-Id: If4dcddfbdbc40e795f4306e83ede43187dd2439c
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-30 10:12:00 +00:00
Leena Miettinen
45b96d12e5 Doc: Describe writing docs for independent plugins
Plugins that reside in their own repositories need their
own documentation.

Change-Id: I97ff5b2b6788c6dd90364117e842dcdfd63085b5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-05-28 07:42:04 +00:00
Leena Miettinen
6741eb9293 Doc: Update guidelines for writing Qt Creator documentation
- Include information about writing Qt Design Studio Manual
  from its README file
- Update information about building the docs

Change-Id: Iaaff47ca3f07c859aa726e7e7f571042a8aadd48
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-04-02 07:07:52 +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