Commit graph

194 commits

Author SHA1 Message Date
Olivier Goffart
9fa59d38cd Generate the enum documentation based of the common/enums.rs
So that makes it harder to forget to update the docs

Note that the new builtin_enums.md does not contain a `### Values`
section header anymore. Also some enum where documented with the full
enum value (such as `TextHorizontalAlignment.left`) while now this
is omitted

The CI should fail if one forget to run `cargo xtask enumdocs` after
adding an enum or changing the docs
2022-05-13 13:15:51 +02:00
ogoffart
3709ded44d Bump version number to 0.2.5 2022-05-09 16:16:00 +00:00
ogoffart
c160ec2aef Bump version number to 0.2.4 2022-05-09 13:49:25 +00:00
ogoffart
6395cdfc09 Bump version number to 0.2.3 2022-05-04 12:32:58 +00:00
Olivier Goffart
452bc2a696 Update MSRV to rust 1.59 in the CI and documentation
This is only required for dependencies of slint-build and xtask.
So this is not enforced yet and will still work with 1.56 with
for C++ or when not using slint-build.
2022-04-14 19:18:05 +02:00
Simon Hausmann
4c88b2b19b Start a page with examples and recipes
This is the beginning of a page to collect common things users need to
do, in a format that they can copy & paste into their application code.

There's a lot more that could be done though.
2022-04-04 10:01:26 +02:00
Simon Hausmann
ed5b76e7fc Improve syntax highlighting in the language reference
Highlight all Slint code and don't do the preview on snippets where it
doesn't make sense.

Some snippets, such as the bare statement or expression snippets, are
now highlighted, but they are continued to be excluded from the doctest.
2022-04-04 09:58:09 +02:00
Simon Hausmann
9582168d94 Fix broken links to C++ types in C++ Type mapping documentation
The links to slint::Color (and other types) was coded to their direct
.html file name, so for example classslint_1_1_color.html.
Unfortunately in the CI the class name became classslint_1_1color.html
and therefore the links on our website were broken.

Now my-st parser has a way of resolving links in markdown to references,
basically {cpp:class}`slint::Color`. Unfortunately that link resolution
is not working when used inside markdown tables.

Therefore this patch converts the entire table to restructured text,
where we can use native references to hopefully always generate the
correct links, regardless of the doxygen/breathe/exhale version.
2022-03-31 21:48:27 +02:00
Simon Hausmann
b34f733716 Point C++ users to the new release/0.2 branch
That way version upgrades to new patch release become easier.
2022-03-10 11:08:58 +01:00
ogoffart
7b50791db4 Bump version number to 0.2.2 2022-03-10 08:48:33 +00:00
Olivier Goffart
3b2b1c92a4 Update version number in docs and readmes
```
sed --follow-symlinks -i 's/^\(slint.*\) = ".*"/\1 = "0.2.1"/' **/*.rs **/*.md
sed --follow-symlinks -i 's/GIT_TAG v.*$/GIT_TAG v0.2.1/' **/*.md
```
2022-03-10 08:46:16 +01:00
ogoffart
ecd0fb7ecd Bump version number to 0.2.1 2022-02-10 16:25:28 +01:00
Olivier Goffart
e429968a15 Update version number in the docs 2022-02-09 17:08:19 +01:00
Olivier Goffart
567b54501a Upate the links to the templates repository
Also update a few more links and reference to slint in the readme
I know this means that we will have invalid links and instructions until the release,
but the instructions are already broken anyway
2022-02-09 15:49:18 +01:00
Olivier Goffart
3d209287c2 Docs: add a note that only exported global from the main file are exposed 2022-02-09 14:49:20 +01:00
Simon Hausmann
b2e6745bd3 Remove two more uses of the sixtyfps.io email 2022-02-09 13:16:51 +01:00
Tobias Hunger
4230ac2572
Update copyright information to reflect name change
Also run resue over the codebase and fix complaints from that tool.
2022-02-09 10:27:47 +01:00
Simon Hausmann
fcd1faa336 Fix up the C++ docs explaining how to create a wayland-only build 2022-02-08 14:47:25 +01:00
Simon Hausmann
90d67be1a4 Document the feature renaming in the migration guides 2022-02-08 14:47:25 +01:00
Simon Hausmann
48f3f47401 Rename the x11 and wayland features to backend-gl-x11/wayland 2022-02-08 14:47:25 +01:00
Olivier Goffart
40c0e446c8 C++ migration guide: merge the two cmake entries
I kept it at the beginning because that's the first thing to do while migrating
2022-02-08 12:34:57 +01:00
Olivier Goffart
00ff5e21a7 Update git repository URL 2022-02-08 08:26:21 +01:00
Simon Hausmann
ee59e9931f Use the logo URL for the C++ docs
It appears that

    https://github.com/readthedocs/sphinx_rtd_theme/pull/1171

and

    https://github.com/sphinx-doc/sphinx/pull/9381

have been released in their respective packages and we can use the logo url in our docs.
2022-02-07 17:22:18 +01:00
Simon Hausmann
906aa0b8c2 Use Tobias' new adjusted diagram 2022-02-07 16:23:41 +01:00
Tobias Hunger
c2d4924294
Use new logo in C++ docs 2022-02-03 14:27:15 +01:00
Tobias Hunger
03f78af987
Update some .60 to .slint 2022-02-02 17:29:40 +01:00
Olivier Goffart
d4c1130130 Rename more occurences 2022-02-02 17:19:31 +01:00
Simon Hausmann
2bba5be38d Fix yocto instructions 2022-02-02 16:55:26 +01:00
Olivier Goffart
3594c20153 Replace SixtyFPS in many locations (Uppercase) 2022-02-02 15:49:18 +01:00
Simon Hausmann
f48d7d9f9e SixtyFPS -> Slint in the C++ documentation 2022-02-02 15:19:13 +01:00
Olivier Goffart
ad4eea9e96 Merge remote-tracking branch 'master' into wip/rename
Conflicts:
	.reuse/dep5
	Cargo.toml
	api/cpp/README.md
	api/cpp/docs/conf.py
	api/rs/slint/Cargo.toml
	docs/development.md
2022-02-02 15:04:22 +01:00
Olivier Goffart
62b269ae44 Replace sixtyfps- 2022-02-02 14:46:27 +01:00
Olivier Goffart
d2d6a5cc6a Rename sixtyfps_ 2022-02-02 14:25:56 +01:00
Olivier Goffart
fc6b7cc966 Replace sixtyfps:: almost everywhere 2022-02-02 13:50:44 +01:00
Olivier Goffart
69908a32b6 Rename sixtyfps-viewer -> slint-viewer 2022-02-02 13:19:40 +01:00
Simon Hausmann
fcf59f3793 Rename the C++ header files 2022-02-02 13:07:26 +01:00
Olivier Goffart
7f7b620a35 Update the injected scripts to the new name 2022-02-02 12:26:55 +01:00
Simon Hausmann
7d297da2fc Rename the sixtyfps C++ namespaces 2022-02-02 12:11:27 +01:00
Olivier Goffart
692171bf0c Change the 60 blocks to slint blocs in documentation comments 2022-02-02 10:51:42 +01:00
Olivier Goffart
03534039d6 Replace more .60 by .slint
Mainly an automated change with
    git grep -O"sed -i 's/\.60/.slint/g'" -w "\.60"

and some manual checks
2022-02-02 10:12:31 +01:00
Simon Hausmann
b1a70f9e58 Rename the SixtyFPS CMake interface 2022-02-02 09:58:26 +01:00
Simon Hausmann
98ffd629cf Exclude private C++ API from the reference documentation
The path to the API meant to be excluded needs to be adjusted after the folder renaming.
2022-02-02 09:20:56 +01:00
Olivier Goffart
1f4c625fac
Mention the change of SOURCE_SUBDIR in the C++ migration docs
cc #910
2022-02-01 22:12:48 +01:00
Tobias Hunger
842f75e653 [reorg]: Move api/sixtyfps-rs/sixtyfps-* into api/rs 2022-01-31 18:24:33 +01:00