Commit Graph
29 Commits
Author SHA1 Message Date
Laurens Valk 4a7fa12eaa config: add classlink directive
We have index pages for most modules now, which link to individual classes. It is helpful if these empty class headers are hyperlinks. This commit does just that.

For most sensors/devices so far this is not really necessary as the images are already hyperlinks. But this will become more useful as we start adding index pages like these for classes without images, such as parameters.
2021-02-14 15:39:39 +01:00
Laurens Valk 55d7a8a254 examples/pup: acceleration and angular velocity 2021-01-20 16:02:36 +01:00
Laurens Valk e051455e23 examples/pup: add imu tilt examples 2021-01-20 14:55:27 +01:00
Laurens Valk 1573508f75 examples/pup/primehub: auto rotate display 2021-01-20 11:05:09 +01:00
Laurens Valk 018b0d8b9d examples: simplify hub script generator
Instead of saying that some lines should be skipped, just say for which hubs the entire script will work.
2021-01-20 10:56:21 +01:00
Laurens Valk 21e5400ff3 api/common/IMU: publish draft API 2021-01-19 15:09:06 +01:00
Laurens Valk bb77e0f413 doc/hubs: link inventorhub to primehub 2021-01-19 11:45:14 +01:00
Laurens Valk 93f27f61e7 doc/hubs: make naming consistent 2021-01-19 11:19:39 +01:00
Laurens Valk 7d40e07dfb doc/hubs: InventorHub and PrimeHub on same page
Make it a bit more explicit that they are the same.
2021-01-19 11:18:21 +01:00
Laurens Valk 69c32e5c0d doc: fix image paths
Use full path just like all other images in the api docs
2021-01-18 12:42:15 +01:00
Laurens Valk 400067c364 doc/hubs/ev3brick: use footnote instead of toggle
This is a way to make the language list non-distracting without the contentui plugin
2021-01-12 16:50:18 +01:00
Laurens Valk 05ecf8bcb6 doc/hubs: show IMU on Prime and Technic Hub 2021-01-05 16:31:35 +01:00
Laurens Valk f3f0532f74 doc/hubs: move note about identical classes
Otherwise, it was shown after the newly added __init__ docstring, which was confusing.
2021-01-05 16:31:35 +01:00
Laurens Valk e52130b627 api/hubs/inventorhub: enable IMU
The minimal change to start reviewing and improving IMU api and docs.
2021-01-04 17:25:16 +01:00
Laurens Valk ab4da63029 doc/hubs: move examples to dedicated sections
Now that each hub is on its own page, we no longer need to collapse snippets to reduce page size. Now they can just all be at the bottom of the page. This also gives each a dedicated link which is easier when giving support.
2020-12-29 13:58:17 +01:00
Laurens Valk d2de1089d6 doc/hubs/index: clean up thumbnail page 2020-12-29 11:50:55 +01:00
Laurens Valk 84b882f8b8 api/hubs/InventorHub: add speaker instance 2020-12-18 13:35:19 +01:00
Laurens Valk c3fc818037 doc/common/Speaker: move note information back
We were hiding this under a toggle menu to reduce the page size of the hubs module. Now that each hub is on its own page, this is no longer necessary.

In turn, this makes it easier to document the same method for other hubs.
2020-12-18 13:32:18 +01:00
Laurens Valk 3e322165f5 doc/hubs: include light matrix display examples 2020-11-11 18:57:04 +01:00
Laurens Valk 983562f7b8 doc/hubs/inventorhub: document light, display, buttons 2020-11-06 15:59:02 +01:00
Laurens Valk 1c9d0dd86f api/hubs/PrimeHub: enable buttons 2020-11-06 15:55:48 +01:00
Laurens Valk e92fd1f05b doc/hubs/primehub: align button and display 2020-11-06 12:45:49 +01:00
Laurens Valk 9a45c6582c doc/hubs/PrimeHub: add labeled diagrams 2020-11-06 12:38:03 +01:00
Laurens Valk 8f21cea345 api/common: clean up Light Matrix
This renames the generic class from LightGrid to LightMatrix. The instance object is simply called display.

This makes user scripts easier to type and read.

This also cleans up most of the draft docstrings for this class and fixes a few argument typos.
2020-11-06 12:31:42 +01:00
Laurens Valk 31f2e9b071 examples: update paths in docs 2020-11-04 10:17:33 +01:00
Laurens Valk 9bcbfd2512 doc/primehub: note to clarify classes are the same 2020-10-25 21:34:05 +01:00
Laurens Valk 1e7991f68d doc/inventorhub: expose hub in the docs 2020-10-25 21:31:05 +01:00
Laurens Valk d2a5cb2d60 doc/hubs: make visual table of contents 2020-10-25 20:51:56 +01:00
Laurens Valk 7b090d56d8 doc/hubs: move hubs to dedicated pages
The hubs module page was getting too long, leading to much scrolling.
2020-10-25 20:37:51 +01:00