Commit graph

30 commits

Author SHA1 Message Date
Simon Hausmann
eaf634f618 Add a note about Skia build issues on Windows 2023-09-12 12:04:36 +02:00
Simon Hausmann
c8b05c2b05 Add documentation about the different renderers, their pros/const, and availability in backends and API 2023-09-12 11:28:17 +02:00
tronical
b8b9db4e42 Bump version number to 1.3.0 2023-09-05 15:46:36 +02:00
Simon Hausmann
5a069b08fb Mention GLES requirement for linuxkms 2023-09-04 09:21:45 +02:00
Simon Hausmann
f404e10b4d Shorten linuxkms renderer table a little 2023-09-04 09:17:05 +02:00
Simon Hausmann
2a486edd82 Mark the linuxkms backend as experimental 2023-08-31 11:30:51 +02:00
Simon Hausmann
2b7aa6ba2d Change doc formatting of arguments in callbacks and functions
- Use a single code fence for the entire signature. Some where uses the one, some the other format. This unifies to the single fence that's easy to read and avoids extra visual boxes.
- Removed names from arguments as that's not valid syntax at the moment.
2023-08-30 16:38:25 +02:00
Simon Hausmann
50481e3387 Fix missing backticks in StandardListView::set-current-item docs 2023-08-30 16:38:25 +02:00
Simon Hausmann
d0fbb3e1a4 doc: Fix links to language specific reference docs in Slint reference
Instead of linking to the latest /docs/cpp, etc., link to /releases/XXX/docs/cpp.

(Converted the getting started to markdown while at it )
2023-08-30 14:55:09 +02:00
Olivier Goffart
4920224be0
Rename Slider::vertical to Slider::orientation 2023-08-30 13:43:59 +02:00
Simon Hausmann
e7a883348b Add links from Rust and C++ to the common platform backend docs
... and adjust the C++ platform backend docs a little to the current
state.

cc #3208
2023-08-25 13:22:06 +02:00
Simon Hausmann
5182660bc6 Initial draft for backend documentation
cc #3208
2023-08-24 19:34:08 +02:00
Olivier Goffart
cc006e8baf
Docs: Improve style documentation and mark the cuppertino style as experimental 2023-08-21 16:27:28 +02:00
Kavindra Palaraja
c55dda5ab8 Simplify the debugging techniques topic for readability 2023-08-21 11:22:03 +02:00
Simon Hausmann
d918bc217b Fix C++ docs build
Pin sphinx to the previous release due to

    https://github.com/sphinx-doc/sphinx/issues/11605
2023-08-17 09:22:52 +02:00
Simon Hausmann
96d7bb132c reuse: remove glob for markdown files
Instead, place the copyright and license right into the source.

To satisfy reuse, this also removes the unnecessary MIT.txt
symlinks.
2023-08-17 08:55:28 +02:00
Eric
4b9fb89332
add property for slider to support vertical orientation (#3236) 2023-08-16 09:58:50 +02:00
Simon Hausmann
21e06cd636 Begin documenting supported (target) platforms 2023-08-15 16:32:37 +02:00
Simon Hausmann
65f371cca7 Add explicit link title for cross-links
myst-parser fills the blanks in automatically, but when rendered on GH it won't.
2023-08-15 16:15:54 +02:00
Simon Hausmann
26347b7c7a Cross-link HorizontalBox and VerticalBox 2023-08-15 16:15:54 +02:00
Simon Hausmann
3356cf508d Add the Slint version to the title of the C++ reference and Slint reference
The Rust docs already have it in their default, and this adds it to the other two.
2023-08-15 16:10:52 +02:00
Simon Hausmann
e591f8d8ed Fix broken link to EventResult enum
It's an enum, thus in enums.md, not structs.md.
2023-08-15 12:04:43 +02:00
Simon Hausmann
d61a929e34 Move widgets out of builtins/ and into its own section under the language reference 2023-08-15 12:04:43 +02:00
Simon Hausmann
2f66331b2b doc: re-order language reference
Move builtins to after the syntax, so that it's

- intro
- concepts
- syntax
- builtins
2023-08-15 12:04:43 +02:00
Simon Hausmann
b775ec45af Move widget style selection under advanced topics 2023-08-15 10:43:49 +02:00
Simon Hausmann
5058b80cd6 Rename reference/src/language/reference to reference/src/language/syntax
This is the reference about the syntax, not a reference in a reference :)
2023-08-15 10:43:49 +02:00
Simon Hausmann
6412c2d8aa Improve wording of getting started
Without the language introduction, this needs a little clarification.
2023-08-15 10:43:49 +02:00
Simon Hausmann
18031c7a43 Move "Getting Started" into the Introduction section 2023-08-15 10:43:49 +02:00
Simon Hausmann
bf7e7e7323 Move debugging techniques under advanced topics in the Slint reference 2023-08-15 10:43:49 +02:00
Simon Hausmann
870e0e541d Restructure the Slint reference documentation
- Move the language reference into a sub-section of its own
- Made Reciples & Examples a top-level section

This paves the way for adding more top-level sections, such as advanced topics (with debugging techniques), or the list of supported
platforms.
2023-08-15 10:43:49 +02:00