Commit graph

75 commits

Author SHA1 Message Date
Simon Hausmann
3323ec8b1b C++ docs: Bump the copyright year 2021-07-02 15:39:33 +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
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
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
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
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
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
98cec35080 Increase version numbers 2021-06-28 10:39:43 +02:00
Tobias Hunger
e01bd87df8 Janitor: Fix warnings about markdown files
These might change the layout of the rendered markdown files. This will
also fix some typos along the way:-)
2021-06-28 08:32:25 +02:00
Tobias Hunger
13d7f5e7bd Janitor: Fix typos in comments and user-facing strings
Also adapt tests for error messages containing the fixed strings.

No behavior change is intended!
2021-06-28 08:32:25 +02:00
Simon Hausmann
6d06827938 Re-enable doc errors in this branch 2021-06-26 10:07:59 +02:00
Simon Hausmann
325751a695 Revert "Disable clang in doxygen again for now, but make doxygen warnings errors"
This reverts commit e6727e6957.

Unfortunately in the CI the warnings as errors doesn't quite work as
well yet, producing different warnings that need fixing first.
2021-06-26 08:04:30 +02:00
Simon Hausmann
4611cfb24f
Fix doxygen warn as error
The version in the CI only supports YES
2021-06-25 23:04:14 +02:00
Simon Hausmann
e6727e6957 Disable clang in doxygen again for now, but make doxygen warnings errors
Will fix clang support with that next week.
2021-06-25 21:22:53 +02:00
Simon Hausmann
1c6ff356a4 Minor tweak to the logo in the C++ docs
Remove the sharp edges
2021-06-25 12:46:35 +02:00
Simon Hausmann
f9ef21bffd Add a logo to the C++ docs
This requires working around a bug in sphinx and the rtd theme, hence
the git pinning.
2021-06-25 11:48:36 +02:00
Simon Hausmann
40d8c7633f Enable clang support in Doxygen 2021-06-25 08:48:28 +02:00
Simon Hausmann
376ed43544 Remove the "View Page Source" links from the sphinx docs
The rst source is not really all that interesting :-)
2021-06-24 12:23:58 +02:00
Olivier Goffart
8e44ac2351 Image type: some more docs 2021-05-28 17:05:16 +02:00
Olivier Goffart
052ea15989 Extends the C++ API docs for the interpreter a bit 2021-05-06 10:03:27 +02:00
Olivier Goffart
3380383787 Bump version number
(Does not include docs and README yet)
2021-04-26 13:16:48 +02:00
Olivier Goffart
91ed04a72c Make length (still the default for all property) be the logical length
And a new `physical_length` is now the physical_length unit

Note: this does not change the runtime part yet
2021-04-21 17:15:19 +02:00
Simon Hausmann
bfd2a2add9 Fix exhale warning about overriding PREDEFINED 2021-03-26 10:32:22 +01:00
Simon Hausmann
4142a9198d Include the intrerperter in the doxygen scan
Amends commit 63cfb9b870
2021-03-23 15:59:17 +01:00
Simon Hausmann
63cfb9b870 Revert back to a unified C++ reference docs
Unfortunately I can't separate the interpreter docs from the regular
run-time library C++ docs with exhale/breathe. One way or another it
breaks and one disappears or shows errors. This change reverts commit
0bb497c816, commit
a769b630ca and commit
0e82faf845 and merges the two into one
reference for now.
2021-03-23 15:36:53 +01:00
Simon Hausmann
0bb497c816 Fix C++ Interpreter docs not showing up in detail
The hacked multi-project support doesn't support multiple output
directories, breathe will look only in the default project directory for
doxygen xml files. Therefore share them.
2021-03-23 11:15:13 +01:00
Simon Hausmann
a769b630ca Separate the C++ Interpreter API into a separate library root
Since breathe doesn't support multiple projects by default, this
uses a fork of the monkey-patch extensions to enable this.
2021-03-22 14:37:02 +01:00
Simon Hausmann
0e82faf845 Exclude the interpreter C++ API from the general SixtyFPS API docs
These need to somehow go into a separate top-level item
2021-03-22 10:55:46 +01:00
Simon Hausmann
8372d3f6d8 Rename call_* to invoke_* for callbacks
Fixes #187
2021-03-15 17:01:05 +01:00
Olivier Goffart
98d40e291d Missing version update 2021-01-28 16:37:52 +01:00
Olivier Goffart
5a21f1bd81 Rename emit_ to call_ for callback
Signal was renamed to Callback, but one does not emit a callback, one calls it
2021-01-25 15:59:10 +01:00
Simon Hausmann
5f265ffc09 Split up ComponentWindow::run() into show(), hide() and sixtyfps::run_event_loop()
This allows creating multiple windows for example, and it will allow for
showing windows in those tests that require a mapped window.

As a bonus, the run() function on generated components is not consuming
anymore.
2021-01-19 09:50:22 +01:00