Olivier Goffart
ce65e7871c
Update the GIT_TAG in the readme
2021-10-22 16:51:25 +02:00
Olivier Goffart
4844450d01
Update the version in docs
2021-10-06 14:54:22 +02:00
Olivier Goffart
bbe178aadf
Add links to the template repositories
2021-09-28 08:24:44 +02:00
Olivier Goffart
28932a32a5
Mention the bool
type in the docs
2021-09-24 09:26:00 +02:00
Simon Hausmann
562842f19e
Bump minimum required CMake version from 3.16 to 3.19
...
The upcoming re-organization of the C++ header generation requires the
use of the CORROSION_ENVIRONMENT_VARIABLES target property, which in
turn requires CMake >= 3.19.
2021-09-18 07:32:53 +02:00
Olivier Goffart
c56b965672
Update version number in docs
2021-09-09 08:54:19 +02:00
Simon Hausmann
e193792194
Update copy of the SixtyFPS logo
...
Unfortunately the rtd theme doesn't support the logo url yet in
our setup, so update this svg copy as the original was updated to
remove the space between "Sixty" and "FPS".
2021-09-08 17:31:47 +02:00
Simon Hausmann
5a81976f3b
Allow selecting features in the CMake integration
...
Provide the same features as in the Rust API crate, as CMake
options.
2021-09-03 14:33:55 +02:00
Simon Hausmann
54182ff54b
Add a section to the C++ intepreter intro about global singletons
...
Also minor fixes to the generated C++ global singleton docs.
2021-08-27 17:14:57 +02:00
Simon Hausmann
3212cda271
Add a section to the C++ docs about accessing global singletons
2021-08-27 17:08:57 +02:00
Simon Hausmann
8de3075270
C++ docs: rework the entry points
...
Move the sixtyfps::namespace entry into a dedicated C++ integration overview
page. Also duplicate and specialize the instantiation and model bits, which
differ between the compiled code and the interpreter.
Finally, fix the generated C++ docs to not mention that there's a constructor,
instead we generate a constructor function.
2021-08-27 16:56:36 +02:00
Simon Hausmann
499f75455e
Re-order the side bar in the C++ docs
...
The new order is
1. Getting Started
2. C++ / .60 Integration
3. Reference
The second section will host a broader introduction that is currently hiding
in the namespace.
2021-08-27 14:44:33 +02:00
Simon Hausmann
6d05959c93
Complete the generated C++ code docs to mention globals
...
But there's an entire section still missing with an example.
2021-08-27 14:28:33 +02:00
Olivier Goffart
7c3555e280
Update the version number that shows in the documentation
...
It does not update the version number in the README because
these are either not part of the versionized documentation
or the demantic versioning make it work anyway
2021-08-19 09:57:13 +02:00
Tobias Hunger
aea4ecca99
Apply pre-commit hooks to all files
2021-08-17 22:38:16 +02:00
ogoffart
53f286258c
Bump version number to 0.1.1
2021-08-10 08:06:20 +00:00
Simon Hausmann
66891a299c
Start a new sixtyfps::Window API for Rust, C++, the interpreters and JS
...
The generated component now provides access to a Window type
via the window() accessor function.
This is part of #333
2021-08-03 10:32:04 +02:00
Olivier Goffart
fae6e0b52d
Document that angles are represented in degrees at run-time
2021-07-26 17:36:02 +02:00
Simon Hausmann
b8f208100c
Minor doc fix: Link to the run_event_loop function mentioned in the docs
...
The formatting is not a code block, but I could not figure out how to do
that. A link is still better IMO than a difference in formatting.
2021-07-22 10:55:13 +02:00
Simon Hausmann
8658e50e27
Fix typo
2021-07-22 09:04:55 +02:00
Simon Hausmann
8ef8cb90ec
Remove unused file
2021-07-10 08:23:01 +02:00
Simon Hausmann
e321bece70
Add missing license header
2021-07-10 08:13:13 +02:00
Simon Hausmann
4f8c9b4378
Add a badge for GH discussions as forum
2021-07-10 08:13:13 +02:00
Simon Hausmann
163625fcd3
C++ docs: finish re-organzing the C++ docs entry
...
Instead of repeating the table of contents, provide a proper intro
page - based on the Github README - and group the remaining content
into Getting Started, Reference and Integration sections.
2021-07-10 08:13:13 +02:00
Simon Hausmann
cb9a89d112
C++ docs: Fix the index page
...
Remove the namespace prefix to make the page readable
2021-07-09 17:18:37 +02:00
Simon Hausmann
16ef842856
C++ docs: remove non-existent module index
2021-07-09 17:16:11 +02:00
Simon Hausmann
9e57262487
C++ docs: Fix showing of the version in the theme
...
Not sure where the "release" variable came from :)
2021-07-09 09:59:20 +02:00
Simon Hausmann
be47f708d9
Cleanup: Move docs/html to docs/resources
2021-07-08 07:01:51 +02:00
Simon Hausmann
ad321c7735
Use one shared html file for the syntax highlighting
...
Using Olivier's idea to check the meta tag, we can distinguish rustdoc
from "the rest". The html is included in mdbook by directly by
symlinking head.hbs.
2021-07-08 07:01:51 +02:00
Simon Hausmann
8003c06f3a
Move all HTML/CSS/JS related to preview and syntax highlighting in the docs into a shared folder
...
This will also be the place where the .60 language definition for
highlight.js can go.
2021-07-08 07:01:51 +02:00
Simon Hausmann
43d20dece9
Add support for .60 syntax highlighting in C++ docs
...
Relates to #281
2021-07-07 14:00:04 +02:00
Simon Hausmann
77898796da
Rust docs: Split up the preview from the syntax highlighting
...
The preview is now in sixtyfps-docs-preview.html and the highlighting in
sixtyfps-docs-highlight.html. This faciliates reusing the preview from
C++ while using a different HTML file later for syntax highlighting.
Relates to #282
Needed for #281
2021-07-07 14:00:04 +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
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