Commit graph

194 commits

Author SHA1 Message Date
Olivier Goffart
65e879e55f
Document how anonymous objects are mapped to native code
As discussed in https://github.com/slint-ui/slint/discussions/2650
2023-04-28 09:30:23 +02:00
ogoffart
dfd5fc38b3 Bump version number to 1.0.3 2023-04-26 14:04:08 +00:00
ogoffart
53cce5bf44 Bump version number to 1.0.2 2023-04-26 11:33:16 +02:00
ogoffart
bd63218412 Bump version number to 1.0.1 2023-04-18 14:56:40 +00:00
Simon Hausmann
db29d01892 C++ docs: Fix red warning in generated HTML for file and namespace listings
The Furo theme by default generates a "on this page" contents list in
the right column. The breathe output for C++ namespace and file pages
also includes a ::contents:: RST directive, to summarize the available
headings. The duplication of these two is warned about by furo with a
big fat red warning.

Solve this by not making breathe generate the contents directive
anymore. According to

    https://exhale.readthedocs.io/en/latest/reference/configs.html?highlight=contentsspecifier#exhale.configs.kindsWithContentsDirectives

it's by default used for files and namespace, so make it empty in our
config.

Fixes #2505
2023-04-14 11:46:53 +02:00
Simon Hausmann
a5bea16596
Add Ninja to the list of required tools (#2498)
We have plenty of command lines that explicitly use `-GNinja`, so let's
make Ninja a tool that is required. That's easier than changing all the
command lines to have two variants (use XX or YY if you have Ninja
installed), and we know that the dependency handling works best with
Ninja.

Fixes #2495

Co-authored-by: Olivier Goffart <olivier.goffart@slint-ui.com>
2023-04-11 16:35:28 +02:00
Olivier Goffart
fd3f974d7e Don't use old syntax in docs 2023-04-06 17:06:46 +02:00
Tobias Hunger
64022bf0bd docs: Document release tags for use in cmake 2023-04-01 23:21:31 +02:00
Olivier Goffart
45c19d6154
C++ docs: fix the dir that should be passed to CMAKE_PREFIX_PATH 2023-03-31 11:25:42 +02:00
Olivier Goffart
cdaf2abb47
C++: sort the member of a struct in the same order as in the .slint file 2023-03-29 19:11:33 +02:00
Tobias Hunger
6934b7b779 cmake: Fix SLINT_EMBED_RESOURCES
* Do not use the initialize_from feature introduced in cmake 3.23
2023-03-27 16:18:05 +02:00
Tobias Hunger
e5c44ad5a1 Update api/cpp/docs/cmake.md
Co-authored-by: Simon Hausmann <hausmann@gmail.com>
2023-03-27 09:27:44 +02:00
Tobias Hunger
c5ecade881 Rename embed-resources parameters fro the Slint compiler 2023-03-27 09:27:44 +02:00
Tobias Hunger
bad588e1e4 cmake: Document resource embedding 2023-03-27 09:27:44 +02:00
Tobias Hunger
52a70b7d89 cmake: Bump minimal cmake version to 3.23 2023-03-27 09:27:44 +02: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
4af7ea8ab7 Switch to the Furo theme for the Slint Language and C++ documentation 2023-03-23 09:34:16 +01:00
Tobias Hunger
1f877887cd docs: Remove builtin_ prefix from files in builtins dir 2023-02-24 12:04:22 +01:00
Simon Hausmann
ecb7819e9b doc: Fix links from C++ docs to the Slint Language Documentation
Fix paths and use HTML anchors, as the markdown links won't turn into
links as the files don't exist yet in that location.
2023-02-23 15:21:04 +01:00
Simon Hausmann
7e843a30d8 doc: Move the recipes into the Slint Language Documentation 2023-02-23 14:20:10 +01:00
Tobias Hunger
39d215bee0 docs: Rename "Slint language Reference" to "Slint Language Documentation" 2023-02-22 21:13:47 +01:00
Tobias Hunger
78892cdf1f docs: Fix broken links in our docs. 2023-02-22 17:08:30 +01:00
Tobias Hunger
96f75bdd0c
docs: Rework the rust part of the documentation (#2240)
Co-authored-by: Simon Hausmann <hausmann@gmail.com>
2023-02-20 21:06:05 +01:00
Tobias Hunger
1a31c9a50b
docs: Polish the C++ docs (#2229) 2023-02-15 15:47:45 +01:00
Tobias Hunger
d93445bd0b docs: Remove inline langref documentation and link the mdbook
For node and cpp, I use relative links to point to the slint language
reference documentation.

For the slint crate documentation I create a link to
https://slint-ui.com/releases/VERSION/... instead: This needs to work from
docs.rs as well as from our own docs area on slint-ui.com! That is
pretty ugly: I can not even define constants for this as the crate docs
need to come before anything else.
2023-02-07 12:10:07 +01:00
ogoffart
e7f48512ee Bump version number to 1.0.0 2023-02-03 11:07:15 +01:00
Simon Hausmann
7e02fa8b6a Update the syntax used in the different documentation entries and README 2023-01-25 09:54:50 +01:00
Simon Hausmann
25a71afa53 doc: fix missing types mapping table in C++ 2023-01-11 15:40:51 +01:00
Simon Hausmann
3c65c6177d Fix C++ memory game tutorial not starting out of the box on Windows
After commit 3e5aa212d5 the Slint DLLs
aren't placed in the `bin/` directory by default anymore. Since the
tutorial builds Slint as an external sub-project, it is entirely
isolated and the CMAKE_*_OUTPUT_DIRECTORY variables do not propagate. On
macOS and Linux, the program still runs due to rpath. On Windows, the
instructions said to put `bin` into `%PATH%`, but that doesn't work
anymore, the dll is now in `_deps/slint-build`.

Instead of adjusting `%PATH%`, this change adjusts the documentation to
recommend the use of a custom command on Windows using
$<TARGET_RUNTIME_DLLS:tgt> to copy the DLL across. This is guarded with
WIN32 due to https://gitlab.kitware.com/cmake/cmake/-/issues/23543 ,
where the proposed solution requires CMake 3.26 (not released yet).
2023-01-09 13:30:13 +01:00
ogoffart
ce07d078ce Bump version number to 0.3.4 2022-12-16 09:36:15 +00:00
ogoffart
fb02b4118b Bump version number to 0.3.3 2022-11-28 13:11:11 +00:00
Simon Hausmann
d8a1f2cf01 Introduce a rem unit in the type system
This allows specifying font sizes relative to the Window's
default-font-size, similar to CSS rem.
2022-11-24 11:33:38 +01:00
Olivier Goffart
f1c96a391c C++ docs: mention we need to set the PATH 2022-11-10 07:45:08 +01:00
Simon Hausmann
a1f9e39054 doc: prospective fix for rendering of example snippet in C++ generated code docs
The sample component in the docs has nothing to see, disable preview.
2022-11-02 09:54:03 +01:00
Simon Hausmann
34b39a2a60 Remove slint::testing from the C++ API Docs
We already avoid parsing `slint_testing.h`. But we have a variant of
`send_keyboard_string_sequence` in `slint_interpreter.h` because the
function takes a ComponentInstance. Exclude all symbols from that
namespace from the docs to continue the intent.
2022-11-01 15:34:35 +01:00
ogoffart
2171773a3e Bump version number to 0.3.2 2022-10-28 09:30:14 +00:00
Simon Hausmann
5e4abec477 Add a backends section to the CMake docs
That's derived from the backends section of the Slint API crate (Cargo.toml)
2022-09-22 12:56:18 +02:00
ogoffart
261614b914 Bump version number to 0.3.1 2022-09-15 14:39:51 +02:00
Simon Hausmann
8556ad0864 Refer to the release/0.3 branch instead of release/0.2 for the CMake docs 2022-09-14 15:45:16 +02:00
Simon Hausmann
012dc34975 Remove the Rust and C++ migration guides from the documentation 2022-09-09 16:53:49 +02:00
Olivier Goffart
8850959a2c Rename the backend feature flags 2022-09-07 17:11:57 +02:00
ogoffart
05a49da906 Bump version number to 0.3.0 2022-09-06 13:00:22 +02:00
Simon Hausmann
a7121a6177 Remove erroneous mention of SLINT_FEATURE_EVENTLOOP_WINIT_ALL
We used to have SLINT_FEATURE_BACKEND_GL_ALL, but when we introduced the
renderer and event loop distinction in the features, we removed the "all" suffix from
the event loop that includes x11 and wayland support.
2022-09-01 11:25:49 +02:00
Simon Hausmann
3619989fcc Rename backend feature flags to accomodate more renderers
Split backend-gl-* into eventloop-winit-* and renderer-femtovg.

The old feature names are still available.

For consistency eventloop-qt and renderer-qt are aliases for backend-qt.
2022-07-26 17:43:51 +02:00
Simon Hausmann
fe3d4b7177 Bump MSRV to 1.60 2022-07-26 09:20:52 +02:00
Olivier Goffart
0c7ad1aa41 Unpin the markdown dep
Because https://github.com/ryanfox/sphinx-markdown-tables/issues/36 was
fixed, and now the workaround is actually causing an error
2022-07-25 12:03:43 +02:00
Olivier Goffart
dd5adebcdc C++ docs: pin the markdown version to fix build error in CI:
```
Extension error (sphinx_markdown_tables):
    Handler <function process_tables at 0x7fcce7e1dc10> for event 'source-read' threw an exception (exception: __init__() missing 1 required positional argument: 'config')
```
2022-07-18 15:51:14 +02:00
Olivier Goffart
ec483e500e Pin all pythin depeds in order to attempt to fix the C++ docs 2022-07-18 15:24:58 +02:00
Simon Hausmann
0b118577da
Pin markdown tables extension
There was an api change, so pin to the previous version for now.

Prospective fix for nightly build failure.

We should probably pin all dependencies (at least semver style) - it’s a miracle this hasn’t broken earlier :)
2022-07-16 09:30:37 +02:00
ogoffart
6b15d2e479 Bump version number to 0.2.6 2022-07-06 09:58:14 +00:00