Commit Graph

73 Commits

Author SHA1 Message Date
Hiroshi Miura
2615219b70 docs: remove explanation of a legacy command syntax
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2024-09-29 11:29:55 +09:00
Hiroshi Miura
4a1aba973e docs: Update cli document for Qt 6.8.0
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2024-06-20 21:16:39 +09:00
Andrew Wason
305abad941 Update docs 2024-03-06 13:04:28 -05:00
Dave Dalcino
dcc6924222 update documentation for --autodesktop flag 2023-09-12 16:21:48 -07:00
Hiroshi Miura
7bbca9bfb6 docs: update URL in cli manual
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2023-08-01 16:20:01 +09:00
Thorbjørn Lindeijer
7c65f6640f Fixed command to check tools_mingw90 version (#680)
* Fixed command to check tools_mingw90 version

* Update docs/cli.rst

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
2023-05-26 08:22:08 +09:00
Dave Dalcino
667aac6f9b Docs: fix broken commands
The docs suggest using `install-tool` commands that are clearly broken,
since they omit the `target` argument, which should be `desktop`.
2023-02-19 11:48:01 -08:00
Dave Dalcino
071932963e Docs: improve language
`tool_name` and `tool_variant` is more specific than `package`
2023-02-19 11:45:50 -08:00
Dave Dalcino
001350e35a Docs: explain MinGW 11.2.0 and tools_mingw90 2023-02-19 11:22:10 -08:00
Dave Dalcino
6e97b9fca9 Update documentation for --autodesktop flag
The `--autodesktop` flag is only useful when installing Qt6 for mobile
or wasm. There is no need to have an additional desktop Qt installation
for any Qt5 mobile or wasm installs. This updates the docs to reflect
that.
2023-02-13 13:13:03 -08:00
Dave Dalcino
6d39111443 Update docs 2022-11-16 16:14:55 -08:00
Dave Dalcino
6e8ae8eba9 Improve docs for changed --autodesktop flag 2022-10-12 17:29:12 -07:00
Hiroshi Miura
d82d20f95e Update documents
- Add --autodesktop example on README
- Update patch version in examples
- Add missing changes

Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2022-09-23 12:20:14 +09:00
David Dalcino
0fe801746a Update Mac CI pipelines to use MacOS-12 (#541)
* Update Mac CI pipelines to use MacOS-12

The MacOS-10.15 CI runners are now deprecated, and will begin brownouts in August. See discussion here: https://github.com/actions/virtual-environments/issues/5583

MacOS-11 is also available, in case there are any issues with 12.

* drop non-functional qt

* add warnings about Qt < 6.2 to docs

* specify Qt 6.2.4 as the minimum for ios
2022-09-18 15:34:08 +09:00
Dave Dalcino
687adb1834 Add --autodesktop to docs 2022-08-20 07:53:03 -07:00
Dave Dalcino
ff2d1dad2c Add documentation for the new --long-modules flag 2022-08-13 11:12:49 -07:00
David Dalcino
9cefd45eee Add explanation of --config flag in CLI docs
This adds the `-c | --config` flag to the CLI section of the documentation.

This problem was discovered while investigating #488. It does not attempt to fix that issue.
2022-02-19 12:51:25 -08:00
David Dalcino
633cbacc62 Update docs and help text for --archives 2021-12-05 11:53:42 -08:00
David Dalcino
05cc2347c7 Merge branch 'master' into topic-fix-453 2021-11-24 22:01:27 -08:00
David Dalcino
db4db6c9a4 Implement --archive-dest feature 2021-11-24 13:30:48 -08:00
David Dalcino
6d1ff77cd4 Change target param for install-src/doc/example
This changes the CLI so that the `target` parameter for `install-src`,
`install-doc`, and `install-example` is now ignored, and "desktop" is
substituted for anything the user inputs. The only valid option here
is "desktop" anyway, so the user should be forgiven for trying to input
anything else.

It may be better to remove `target` from the parameter list, but that's
a big change to the interface that could break a lot of dependent code.
2021-11-23 11:10:10 -08:00
David Dalcino
b929dc1f4b Add docs for list-src, list-doc, list-example 2021-11-23 11:08:02 -08:00
David Dalcino
104716e53b Add suggested tool '7zip' to documentation
This adds a note to `docs/cli.rst` in the section on the `--external`
flag that suggests use of the "7-zip" extractor, and links to the
7-zip website and to package managers that can install it.
2021-10-29 11:08:31 -07:00
David Dalcino
479be0f903 Replace broken url
This replaces the Berkeley url with a mirror link that works, in case a user copies it into their terminal.
2021-09-25 11:40:17 -07:00
David Dalcino
2c036a872d Fix broken mirror link
This is meant to allow CI builds to run successfully when the mirror link in `cli.rst` is broken. It accomplishes this by changing the link into an html 'code' tag. The link is not meant to be clicked on; it is meant to be typed as a command line argument. This change makes the intention more explicit.

It may be better to replace the link with a working URL, perhaps one of the links in the settings.ini file.
2021-09-25 11:35:22 -07:00
David Dalcino
7104dbcdf7 Merge remote-tracking branch 'upstream/master' into add-list-qt-archives 2021-09-20 18:49:46 -07:00
Hiroshi Miura
08f430da22 Merge pull request #401 from ddalcino/list-modules-requires-arch
Require architecture when listing modules
2021-09-21 08:25:38 +09:00
David Dalcino
31bfa11752 Add docs for changed --modules syntax 2021-09-17 12:41:42 -07:00
David Dalcino
7e3ee87fcc Merge remote-tracking branch 'upstream/master' into add-list-qt-archives 2021-09-17 08:41:07 -07:00
David Dalcino
248329c457 add documentation 2021-09-17 08:32:49 -07:00
Mozi
0b7403aaa6 docs: correct the parameter of "list-tool"
The table-like output is affected by the "--long" or "-l" option.
2021-09-17 22:11:38 +08:00
Mozi
b730fa7a17 docs: fix format of a "list-tool" code block 2021-09-17 21:53:54 +08:00
David Dalcino
4230bab604 Document the 'install by spec' feature 2021-09-09 11:58:17 -07:00
David Dalcino
555080f40b Organize cli.rst into categories 2021-08-05 20:49:42 -07:00
David Dalcino
3e9da57737 Reorder --extension/--extensions flags 2021-08-04 05:42:38 -07:00
David Dalcino
3be780f793 Fix link to SimpleSpec 2021-08-04 05:35:38 -07:00
David Dalcino
76cfd47d82 Revert "Add links to option flags"
This reverts commit ddc36064
2021-08-04 05:35:25 -07:00
David Dalcino
ddc36064dc Add links to option flags 2021-08-04 01:00:40 -07:00
David Dalcino
cd93922931 Fix title underline length 2021-08-03 23:32:14 -07:00
David Dalcino
fd1d640c8c Add link to docs for legacy commands 2021-08-02 18:23:43 -07:00
David Dalcino
c2c9d8dd6d Fix grammar/punctuation in cli.rst 2021-08-02 18:09:46 -07:00
David Dalcino
6a0aa109ef Use 'host' and 'target' in docs
This removes the terms 'target OS' and 'target variant' from the docs,
and replaces them with 'host' and 'target', as they are referred to in
the program help text and code.
2021-08-02 18:09:46 -07:00
David Dalcino
4cae34af06 Align cli.rst with actual interface
At some point, it looks like the file `docs/cli.rst` got misaligned with
the actual command line interface, and this change fixes that.

This moves the `version` subcommand into the 'generic commands' section.

This adds several command line options to `aqt install-qt` that were
missing from the docs, and removes `--version`, which is not an option
for `aqt install-qt`.
2021-08-02 18:09:46 -07:00
David Dalcino
6f073033f7 Fix formatting of things a user types
This change causes anything in the docs that a user should type in a
console, like a command, an option, or an argument, to be formatted as
monospaced code.
2021-08-02 18:09:35 -07:00
David Dalcino
3ea269c922 Fix broken links and add necessary links
This fixes the broken links to the 'Available Qt Versions` wiki page.
It also adds links to 'List Qt Command' in the documentation for the
'Qt Install Command'.
2021-08-02 17:50:52 -07:00
David Dalcino
ab7b2b8d1d Fix new command syntax in documentation 2021-08-01 13:58:23 -07:00
Hiroshi Miura
0435bfd1b6 docs: Add explanation of command changes
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2021-08-01 15:15:56 +09:00
David Dalcino
4f0d92dc97 Fix warnings when rendering sphinx docs (#350)
* Rename duplicate labels

When using 'sphinx.ext.autosectionlabel', labels are automatically
generated with the same name as the title of each section.
This change renames the manually created labels so that they do not
clash with the autogenerated labels, and silences the warnings
triggered by them.

* Extend title underlines

This silences the warning about the title underlines being too short.

* Add blank line after "code-block" directive

Silences this warning:
WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 9 supplied.

* Add blank line where required by sphinx docstring

Silences this warning: WARNING: Unexpected indentation.

* Revert "Rename duplicate labels"

This reverts commit 442d2d81

* Add explicit labels for `cli.rst` sections

* Disable sphinx.ext.autosectionlabel

* Turn off html static path

The '_static' path is not being used, and it doesn't even exist, which
triggers a warning. This change silences that warning.

* Fix label for 'qt installation command'
2021-07-29 23:37:19 +09:00
Hiroshi Miura
b5c1b00aa1 use command name discussed in #306
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2021-07-26 08:35:44 +09:00
Hiroshi Miura
4f997f2a62 docs: update program/option directives
Trial discussed in #339

Signed-off-by: Hiroshi Miura <miurahr@linux.com>
2021-07-26 08:12:23 +09:00