Commit graph

501 commits

Author SHA1 Message Date
Simon Hausmann
9784415a7e Fix invalid CMake package config files when using different build types
As we try to copy the different location target properties from the
corrosion target into the package config file, we need to take all the
usual build types into account, not only Debug/Release.

Especially RelWithDebInfo is popular among packagers.
2021-07-06 23:07:35 +02:00
Tobias Hunger
39984b27db Janitor: Fix spelling in comments 2021-07-03 15:49:43 +02:00
Simon Hausmann
5a7ac1735d
C++ docs: minor cleanup in generated code sample
Encode the return type only once, not twice
2021-07-02 22:13:52 +02:00
Simon Hausmann
c74af8cb1a C++ docs: Remove the horizontal scrollbar from the cmake example 2021-07-02 16:22:21 +02:00
Simon Hausmann
8f9a723e75 C++ docs: Add a getting started section
This combines the tutorial sub-section from the intro (a bit weird as sub-section there)
and the usage part of the cmake section into a getting started that
has a complete little C++ example.
2021-07-02 16:22:21 +02:00
Olivier Goffart
13bd828b96 Update license date 2021-07-02 15:55:54 +02:00
Simon Hausmann
570ccc20e9 C++ docs: remove the vtable namespace from the list of namespaces in the API 2021-07-02 15:40:43 +02:00
Simon Hausmann
3323ec8b1b C++ docs: Bump the copyright year 2021-07-02 15:39:33 +02:00
Simon Hausmann
adeb192f6e C++ API: Make LinearGradientBrush and GradientStop private API 2021-07-02 15:34:16 +02:00
Simon Hausmann
9819f7f6b7 C++ docs: Fix one more sphinx warning about unused input .md file 2021-07-02 14:20:29 +02:00
Simon Hausmann
e61c62d340 C++ docs: cut down on sphinx warnings
Excludes files we are not using in the toctree
2021-07-02 14:20:29 +02:00
Simon Hausmann
a77fbcc310 C++ docs: fix warning about misplaced ::note::
We don't really need it and in fact don't even want the light bulb style,
even if it worked :)
2021-07-02 12:32:28 +02:00
Simon Hausmann
f8abd57c3b C++ docs: For the model bits, link to the for-in and ListView docs
Using an rst epiloge we can define global references that are even formatted
(using rst substitutions)
2021-07-02 12:32:28 +02:00
Simon Hausmann
7a81e8deee C++ docs: Fix link to tutorial
my_st ended up trying to interpret the md link, so go to raw html ;)
2021-07-02 10:39:24 +02:00
Simon Hausmann
45f62f5f11 C++ docs: Provide a short intro paragraph to the reference section 2021-07-02 10:15:48 +02:00
Simon Hausmann
69bbef529c C++ docs: Link to the section of the generated code from the namespace intro 2021-07-02 09:56:52 +02:00
Simon Hausmann
4705415642 C++ docs: First draft of a sixtyfps namespace intro 2021-07-02 09:46:48 +02:00
Simon Hausmann
e12ef7be6d Fix missing license header 2021-07-01 19:05:41 +02:00
Simon Hausmann
8cd3c30e1b C++ Docs: Organize all .60 language related topics as sub-topics 2021-07-01 18:38:16 +02:00
Simon Hausmann
b61e298984 C++ docs: Allow expanding the tree in the navigation bar from anywhere 2021-07-01 18:19:29 +02:00
Olivier Goffart
7c1dbb949b Fix C++ test 2021-07-01 14:23:57 +02:00
Olivier Goffart
63cf84d21f More MSVC warnings fixes 2021-07-01 14:16:41 +02:00
Olivier Goffart
9b99b558ae Spellcheck 2021-07-01 13:54:26 +02:00
Olivier Goffart
fe81590b07 Silence a bunch of MSVC warnings 2021-07-01 13:47:22 +02:00
Simon Hausmann
01e94ccdbb C++ docs: Shorten the API reference title 2021-07-01 13:41:51 +02:00
Simon Hausmann
38ae2eb872 C++ docs: change the order of topics slightly
Move the C++ type mapping towards the end and the
example generated code at the end.
2021-07-01 13:41:51 +02:00
Simon Hausmann
4662222556 C++ docs: more intro touch-ups
Don't mention the tutorial twice, and there's no need to line to the online docs.
The latter makes sense in the GitHub README, but not in the docs themselves.

Would be nice to fold this "intro" somehow right into the contents
though, without a sub-page. Or the intro becomes bigger with more
references.
2021-07-01 13:06:47 +02:00
Simon Hausmann
af0215eca4 C++ docs: remove pre-alpha notice
We're at version 0.1.0 now :-)
2021-07-01 13:06:47 +02:00
Olivier Goffart
0d9daa1964 C++: silence a few conversion warnings with MSVC 2021-07-01 13:04:25 +02:00
Simon Hausmann
9fc81da862 C++ docs: mention show/hide in the generated code 2021-07-01 13:02:40 +02:00
Simon Hausmann
2440d92c6e C++ docs: One more small cmake touchup
Typo fix and match the order of cmake commands with the list in the docs earlier.
2021-07-01 12:59:47 +02:00
Simon Hausmann
ca0dff21b3 Minor touchup to the usage
and link to FetchContent docs
2021-07-01 11:37:13 +02:00
Simon Hausmann
88b8be0da5 A few cspell tweaks for markdown docs 2021-07-01 11:21:38 +02:00
Simon Hausmann
5b1be43952 C++ docs: Join building and cmake usage section 2021-07-01 11:17:48 +02:00
Simon Hausmann
6b8073983f C++ docs: Move cmake usage into a separate top-level topic
... which is to be expanded further subsequently
2021-07-01 10:46:53 +02:00
Simon Hausmann
888a1296fe Switch the markdown processor for C++ to myst_parser
According to https://github.com/readthedocs/recommonmark/issues/221
recommonmark is being phased out and myst_parser is actively maintained.
2021-07-01 10:30:51 +02:00
Simon Hausmann
2646f442b5 C++: Replace the "quick tutorial" from the README with a reference to the walk-through 2021-07-01 08:29:12 +02:00
Simon Hausmann
34f1838a37 Begin folding the C++ readme into the C++ docs
This just integrates a copy first, which is to  be split up subsequently.
2021-07-01 08:22:30 +02:00
Olivier Goffart
423656d900 Update some more version number
Meaning that following the docs or tutorial won't work until the release is complete
2021-06-30 17:21:38 +02:00
Simon Hausmann
5d58d34e84 Document run_event_loop() and quit_event_loop()
The C++ versions were there before, but undocumented. The Rust version
for quit() was missing.
2021-06-29 16:12:00 +02:00
Olivier Goffart
ccdcb61178 Rename the sixtyfps_compiler binary to sixtyfps-compiler 2021-06-29 14:21:44 +02:00
Simon Hausmann
57a00a4487 Re-add the logo to the C++ docs
For now that means the SVG is duplicated, but once sphinx is fixed we
can share the svg from the website.
2021-06-29 14:17:00 +02:00
Simon Hausmann
be95545474 Bump corrosion
This new version includes fixes to avoid unnecessary rebuilds.
2021-06-29 10:37:02 +02:00
Simon Hausmann
3ab287223c Silence exhale error
Doxygen would still generate xml for private_api::ArrayModel and would
try to resolve a reference to iself, which is not possible because we've
excluded the namespace:

```
   stderr: (!) Critical error while generating the file for [/home/vagrant/sixtyfps/target/cppdocs/api/classsixtyfps_1_1Model.rst].Traceback (most recent call last):
      File "/home/vagrant/.local/share/virtualenvs/docs-4wjFCyEr/lib/python3.8/site-packages/exhale/graph.py", line 2591, in generateSingleNodeRST
        gen_file.write("{0}\n".format(node.baseOrDerivedListString(
      File "/home/vagrant/.local/share/virtualenvs/docs-4wjFCyEr/lib/python3.8/site-packages/exhale/graph.py", line 393, in baseOrDerivedListString
        link=nodeByRefid[refid].link_name
    KeyError: 'classsixtyfps_1_1private__api_1_1ArrayModel'
    ```

Making the entire class as \private works around it.

Oddly, this isn't needed for IntModel, perhaps because it's not a template?
2021-06-28 14:18:45 +02:00
Simon Hausmann
918fa68c28 Revert logo in C++ docs
This reverts the Pipenv pinning of
f9ef21bffd and thus disables the logo, as
subsequent changes in the pinned sphinx fork cause unrelated breakages
when building docs. Let's re-enable this when the fixes are in an
upstream release of sphinx and the rtd theme.
2021-06-28 14:03:45 +02:00
Olivier Goffart
640d178d9d Fix compilation of the C++ interpreter 2021-06-28 12:16:59 +02:00
Olivier Goffart
ae114cf79d C++: don't re-export private symbol in the public API
Use the cbindgen_private namespace dirrectly from the generated code
2021-06-28 12:03:49 +02:00
Olivier Goffart
16ba23ae47 Move StateInfo to the private namespace 2021-06-28 11:23:44 +02:00
Olivier Goffart
daff9e8e65 Move Callback and internal Models to the private_api namespace 2021-06-28 11:23:44 +02:00
Olivier Goffart
98cec35080 Increase version numbers 2021-06-28 10:39:43 +02:00