Commit graph

17 commits

Author SHA1 Message Date
Olivier Goffart
cbd8c6aefc Documentation for the newly added struct type 2020-09-17 13:14:01 +02:00
Simon Hausmann
0dc81895ed Exclude SharedArray::SharedArrayHeader from the C++ docs 2020-09-11 18:35:27 +02:00
Simon Hausmann
29a9bd05eb Remove Pin, etc. typedefs from C++ docs
Exclude everything from vtable.h, and apply the same logic for sixtyfps::testing.
2020-09-11 18:16:17 +02:00
Simon Hausmann
dd6c931237 Hide sixtyfps::testing* from the C++ docs 2020-09-11 18:12:34 +02:00
Simon Hausmann
a3f917652a Exclude VOffset and VRefMut from the C++ docs 2020-09-11 18:11:56 +02:00
Simon Hausmann
6278a7168a Include the example preview also in the C++ documentation
The template system used by Sphinx makes this rather easy, just the selector for the
HTML element to inject to needs to be extended.
2020-09-04 11:44:08 +02:00
Simon Hausmann
f4958abba5 Simplify C++ docs build directory setup
Symlink the _static directory instead.
2020-09-04 11:30:51 +02:00
Simon Hausmann
3eef23f93c Add widgets to the C++ docs as well 2020-09-03 12:05:50 +02:00
Simon Hausmann
834fa12206 Add the builtin elements to the C++ docs 2020-09-03 09:36:30 +02:00
Simon Hausmann
82ecae8ba6 Move the .60 <> C++ type mappings into a separate section
So the README.md remains usable also on Github.
2020-09-03 09:30:46 +02:00
Simon Hausmann
fd9aea97eb Fix markdown table rendering in C++ docs
This reverts commit 0bb904e10a and
re-introduces the markdown table support extension. The resulting table
by default is too wide in the "responsive" read-the-docs theme, but with
a CSS tweak it becomes readable.

Markdown tables are much easier to deal with and this way we can also
include references within the tables.
2020-09-02 17:06:41 +02:00
Simon Hausmann
65ff715fbc Make C++ documentation generation an xtask
Tear it out of the CMakeLists.txt and instead run it via

    cargo xtask cppdocs

This allows the build_and_test step in the CI to only run cmake for the
library/header related bits and the docs_and_demos step to only generate
docs and not require a full host build of the library (as cargo xtask
cmake would otherwise do).
2020-09-01 17:03:55 +02:00
Olivier Goffart
58cdaeb8dd Update license header to mention that commertial option are available 2020-08-26 13:23:42 +02:00
Simon Hausmann
9785919f6e Hide a few APIs from the C++ documentation
Since Doxygen can't seem to just exclude them via command, they are moved
into a private_api namespace and then excluded via Doxygen config:

    * *VTable
    * make_dyn_node, ItemTreeNode, etc.
    * VersionCheck
2020-08-25 17:45:12 +02:00
Simon Hausmann
91621aa87a Hide sixtyfps::cbindgen_private from the C++ docs 2020-08-25 16:43:43 +02:00
Simon Hausmann
3f64defaac Include the C++ API README in the C++ reference docs 2020-08-24 17:40:12 +02:00
Simon Hausmann
e9685c5851 Improve C++ documentation shell
Doxygen's markdown support can't quite deal with the Github flavor,
the language reference looks terrible.

So instead, this change switches to using Sphinx,
with two extensions that call Doxygen for us and allow including markdown.

The result is a read-the-docs themed sphinx site that includes search even
in the language reference.
2020-08-24 17:07:04 +02:00