Commit Graph
16 Commits
Author SHA1 Message Date
Laurens Valk 4bff13b5ca doc: drop separate sound page
The sound is not independently useable, and it is already documented for the speaker.
2020-01-27 13:03:41 +01:00
David Lechner dc82ccce40 resources renamed to media.ev3dev 2020-01-14 17:32:40 -06:00
Laurens Valk ad12d13355 api/nxtdevices: add module 2020-01-14 20:10:33 +01:00
Laurens Valk 94f514cd20 doc/battery: not an independently usable class
There are only the instances on hubs that support it, and they are already documented there, so delete generic copy.
2020-01-14 17:02:30 +01:00
David Lechner f694de2277 pbyricks/resources: new Image and Font classes
This adds API and documentation for the pybricks.resources module
Image and Font classes.
2020-01-13 12:59:07 -06:00
David Lechner 31a639f55b doc/api/conf.py: enable nitpicky
This enables the sphinx doc nitpicky option to detect broken references.

Also fix all of the broken references.
2020-01-11 21:08:20 -06:00
Laurens Valk 21a0b8766e api: rename customdevices to iodevices
These devices are not always custom. Rather, the classes in this module are very generic and apply to a wide range of input/output devices.
2020-01-01 16:41:29 +01:00
Laurens Valk 61bfd359f1 doc: remove example projects
Full project examples are not included in the API.
2019-12-09 16:53:12 +01:00
Laurens Valk be667caa7b doc/signaltypes: move scalars and vectors
This makes it possible to exclude this information from releases that do not use it.
2019-12-09 10:31:22 +01:00
Laurens Valk 653aa669b2 doc+api/customdevices: move AnalogSensor
Generic and custom devices like the AnalogSensor will live in a dedicated module.
2019-11-14 08:47:30 +01:00
Laurens Valk f12c579159 doc: move Motor to dedicated page.
Instead, show shorter, simpler Motor docs platform-devices pages. For the moment, this just means deleting the advanced methods section from those pages, but we may choose to simplify further.

This change makes it easier to navigate the ev3devices/pupdevices pages because the motor sections aren't overly long.

Details will still be available on the Motor pages for those who wish to use the more advanced motor capabilities such as adjusting the PID settings.
2019-11-11 13:22:08 +01:00
Laurens Valk 15f5626948 doc: document new media submodule 2019-11-04 16:58:22 +01:00
Laurens Valk 5c832498b6 doc: motors match module 2019-10-19 21:38:33 +02:00
Laurens Valk 2307a20cf0 doc: simplify module toc 2019-10-19 21:18:59 +02:00
Laurens Valk 2ec5b0aab9 doc: organize motors 2019-10-18 18:32:09 +02:00
Laurens Valk 372e5ccbd0 doc: single api target
Also delete getting started instructions
2019-10-18 18:11:57 +02:00