Commit Graph
358 Commits
Author SHA1 Message Date
Laurens Valk 087dab5ed1 doc/ide: add build target for Pybricks Code
poetry run make -C doc SOURCEDIR=ide html

This adds a build target for docs to integrate in Pybricks Code. This commit makes the build target produce an identical copy, by making each page reference its original rst file.

Now we can easily exclude certain components (such as EV3) as needed for Pybricks Code, and also change the main index / welcome page.
2021-01-18 12:50:27 +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 14ad697565 doc/start_ev3: use rst files instead of inc
Use standard sphinx conventions as much as possible.
2021-01-18 12:00:38 +01:00
Laurens Valk d2a6b07e0c doc/start_ev3: move download link 2021-01-18 11:52:49 +01:00
Laurens Valk 853b141153 doc/start_ev3: group as folder 2021-01-18 11:52:24 +01:00
Laurens Valk 12a6b49f97 doc/frames: drop unused file 2021-01-18 11:13:51 +01:00
Laurens Valk 06c1d00f22 config: drop contentui plugin
We are no longer using this
2021-01-13 16:54:18 +01:00
Laurens Valk 8c0d7a3904 doc/parameters: drop content tabs for sides 2021-01-13 16:54:18 +01:00
Laurens Valk 9b5590047d doc/parameters: drop content tabs for ports 2021-01-13 16:54:28 +01:00
Laurens Valk 46d9e3c119 doc/iodevices: refactor
Split all classes to their own file. This keeps things organized, and allows per-class comments about compatibility. Also flatten toggled examples.
2021-01-13 16:54:18 +01:00
Laurens Valk bb7c9adbb8 doc/start_pup: drop toggles 2021-01-13 15:55:08 +01:00
Laurens Valk 5f4ef05c6e doc/tools: move data logging to separate page
Expand the EV3 examples without toggles, and without making the tools page too long.
2021-01-13 15:44:39 +01:00
Laurens Valk 5bbbff2550 doc/messaging: expand examples
Drop use of toggle via plugin.
2021-01-13 15:13:51 +01:00
Laurens Valk 8f637c52cd doc/media: drop toggle ui 2021-01-13 14:25:08 +01:00
Laurens Valk f826e7641c doc/media: footnote instead of toggle for language
This is a way to make the language list non-distracting without the contentui plugin
2021-01-12 16:50:43 +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 1f991302e5 doc/common: fix unit of acceleration 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 64146f5afa doc/geometry: axis and orientation conventions 2021-01-05 16:31:21 +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 a2583944d9 api/geometry: move Axis from parameters
This location makes more sense. Also drop Axis.ANY = None, which is more confusing than helpful. Instead, use relevant docstring to explain what None will do.
2021-01-04 17:25:15 +01:00
Laurens Valk 4c6c149d4a doc/start_pup: update link to CI builds 2021-01-04 15:28:03 +01:00
Laurens Valk 9835ee9dbe doc/hubs/primehub: update button graphic
The graphic showed Button.BT but it is now Button.BLUETOOTH
2020-12-30 12:42:47 +01:00
Laurens Valk 352bff564c api/parameters/Button: add remote buttons
Also clean up how it is displayed by reading the attributes from the API instead of copying them.
2020-12-30 12:27:12 +01:00
Laurens Valk 313a51219a api/pupdevices/Remote: add address
After connecting (automatically), this address can be printed so next time you can connect directly without scanning.

This is useful if you have more than one remote.
2020-12-29 20:16:34 +01:00
Laurens Valk c2d2884794 api/pupdevices/Remote: publish draft api 2020-12-29 19:51:48 +01:00
Laurens Valk 32a47bcee0 doc/nxtdevices: do not collapse example
In the long run, this page needs to be split up just like pupdevices. At this time, the nxtdevices page has only one example, so we simply remove the toggle header.
2020-12-29 14:53:13 +01:00
Laurens Valk b5890437de doc/pupdevices/PFMotor: split examples
Now that each device 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 14:48:09 +01:00
Laurens Valk b0af924cfc doc/pupdevices/UltrasonicSensor: split examples
Now that each device 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 14:47:06 +01:00
Laurens Valk 915d445561 doc/pupdevices/TiltSensor: split examples
Now that each device 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 14:44:50 +01:00
Laurens Valk 070264647f doc/pupdevices/Light: split examples
Now that each device 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 14:43:08 +01:00
Laurens Valk ab1f58c2cc doc/pupdevices/InfraredSensor: split examples
Now that each device 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 14:42:11 +01:00
Laurens Valk d6bc72c3c1 doc/pupdevices/ForceSensor: split examples
Now that each device 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 14:41:06 +01:00
Laurens Valk 4e2aec6c35 doc/pupdevices/motor: split examples
Now that each device 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 14:35:07 +01:00
Laurens Valk 2375a1abcb doc/pupdevices/colorsensor: split examples
Now that each sensor 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 14:10:41 +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 ab384b464b doc/pupdevices/colordistancesensor: split examples
Now that each sensor 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 12:08:29 +01:00
Laurens Valk d2de1089d6 doc/hubs/index: clean up thumbnail page 2020-12-29 11:50:55 +01:00
Laurens Valk b76b6cf835 doc/pupdevices: one page per sensor
This page was getting very long, so split it up for easier navigation (#33).
2020-12-29 11:47:27 +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 57ff8312f3 api/iodevices/PUPDevice: add info() method 2020-12-18 13:20:17 +01:00
Laurens Valk 68511bd3eb doc/iodevices: note on I2C/UART on Powered Up 2020-12-14 10:34:41 +01:00
Laurens Valk ba4fe80b50 doc/iodevices: add PUPDevice class 2020-12-14 10:27:23 +01:00
Laurens Valk b7d728a86e doc/iodevices: move LUMPDevice to EV3 only section
Also update graphic used for this device class.
2020-12-14 10:16:02 +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