Commit graph

33 commits

Author SHA1 Message Date
Kavindra Palaraja
9f51fd61b7 Improve the landing page for the Slint Language documentation
Remove the Intro page and move that content to the landing page instead.
2023-04-04 18:57:35 +02:00
Alex Kladov
ba793a8447 Update intro.md 2023-04-03 17:04:14 +02:00
Olivier Goffart
6711bf6ea6 Apply suggestions from code review
Co-authored-by: Simon Hausmann <simon.hausmann@slint-ui.com>
2023-03-24 11:15:05 +01:00
Olivier Goffart
8f52015fe5 WIP: layouting attempt to document the behavior we would like to have
For issue #2284
2023-03-24 11:15:05 +01:00
Olivier Goffart
88f9d0aed5 Slint docs style cleanups
- refresh copyright
 - link to slint-ui.com
 - add footer icons
2023-03-23 12:23:31 +01:00
Simon Hausmann
4ca6fd53c9 Re-add syntax highlighting in the Slint Language Docs 2023-03-23 09:34:16 +01:00
Simon Hausmann
4af7ea8ab7 Switch to the Furo theme for the Slint Language and C++ documentation 2023-03-23 09:34:16 +01:00
Simon Hausmann
c1dbe974ef Fix missing navigation sidebar in the slint language docs
The navigation sidebar requires jquery, which from Sphinx >= 6.0 needs
to be bundled via a separate extension. In the C++ docs Sphinx remains
at version 4.5.0 (due to exhale), but the slint language site doesn't
need exhale (no C++) and thus Pip ends up picking a newer Sphinx
version.
2023-03-20 16:04:07 +01:00
Simon Hausmann
26c8221141 Fix doc rendering of remaining callbacks
- Don't show a literal underscore.
- Close the code fence so that the markdown link turns into a real link.
2023-03-06 13:36:14 +01:00
Simon Hausmann
69d2f4a190 Fix markup for FocusScope callbacks 2023-03-06 09:19:42 +01:00
Simon Hausmann
d596f476cf Remove leaked HTML comment 2023-03-03 13:17:11 +01:00
Simon Hausmann
979256142a doc: From Text's text property, link to the string handling
As pointed out by Miłosz, users of this property may very likely be also
interested in string formatting / interpolation.
2023-03-02 13:58:44 +01:00
Tobias Hunger
e9fc3d6025 docs: Hide table of contents in main area 2023-03-01 18:36:21 +01:00
Miłosz Kosobucki
d7bfca8efa Fix TouchArea doc
Incorrect wording, likely due to copy&paste
2023-02-27 16:10:11 +01:00
Tobias Hunger
42d1fbdbcf
docs: Use it's, etc. more consistently (#2287) 2023-02-24 17:42:22 +01:00
Tobias Hunger
5b347e0b13 Add @tronical's suggestions
... and more links ...
2023-02-24 16:09:11 +01:00
Tobias Hunger
ba99dc96a7 docs: Add some doc comments to enums
Update enumdocs xtask to generate the right file...
2023-02-24 16:09:11 +01:00
Tobias Hunger
1f877887cd docs: Remove builtin_ prefix from files in builtins dir 2023-02-24 12:04:22 +01:00
Tobias Hunger
f7de5d4602
docs: Go over builtin_elements.md (#2280)
Co-authored-by: Simon Hausmann <hausmann@gmail.com>
2023-02-24 11:03:56 +01:00
Simon Hausmann
210c86acd5 doc: Move the files belonging to the builtins into a sub-folder 2023-02-23 14:56:44 +01:00
Simon Hausmann
a54ae3068f doc: Move the files belonging to the reference into a sub-folder 2023-02-23 14:52:26 +01:00
Simon Hausmann
8ee5f02334 doc: Remove Concepts -> Concepts sub entry in the Concepts toc 2023-02-23 14:23:12 +01:00
Simon Hausmann
7e843a30d8 doc: Move the recipes into the Slint Language Documentation 2023-02-23 14:20:10 +01:00
Tobias Hunger
2767e6ac39
docs: Merge sub-chapters into the types topic 2023-02-23 14:04:29 +01:00
Tobias Hunger
eec9d31809
docs: Sort and update widgets page in language docs 2023-02-23 13:49:40 +01:00
Simon Hausmann
96fd2d0c7c Doc: Fix broken links 2023-02-23 11:48:35 +01:00
Simon Hausmann
8badc9fddb doc: Remove non-existent index for the slint language docs
Sadly an index is not generated for us with myst-parser :(
2023-02-23 11:48:35 +01:00
Simon Hausmann
d9b0a32d1c doc: Don't repeat the section title in the sub-section title 2023-02-23 11:48:35 +01:00
Simon Hausmann
84a5c85347 doc: Don't show images, structs, arrays and models, and conversions _under_ Colors and Brushes in the toc tree 2023-02-23 11:48:35 +01:00
Simon Hausmann
a61cbd74a3 Move purity to the end of concepts
Preference of priority ;-)
2023-02-23 11:48:35 +01:00
Simon Hausmann
11a3d82f45 Sync the book "title" with the new title we use 2023-02-23 11:48:35 +01:00
Simon Hausmann
8eb0b34439 doc: Shorten the caption titles
It's all in the Slint Language Documentation, so we can make remove the Slint prefix
2023-02-23 11:48:35 +01:00
Tobias Hunger
0867aa1ed9 docs: Move slint language docs from langref to language folder 2023-02-22 21:13:47 +01:00