Commit Graph
19 Commits
Author SHA1 Message Date
Laurens Valk f26d750fbf doc/ev3devices/InfraredSensor: document mode delay 2020-07-10 11:46:04 +02:00
Laurens Valk fe5dc3adee doc/ev3devices/GyroSensor: add speed/angle note 2020-05-19 13:02:20 +02:00
Laurens Valk f5c3ee6ab7 doc/ev3devices: add sensor icons 2020-03-27 14:50:06 +01:00
Laurens Valk 2bdc975f8b doc/ev3devices: add motor icons with directions 2020-03-27 14:16:43 +01:00
Laurens Valk 1158e4e45a api/builtins/Motor: separate methods for stop
stop(Stop.COAST)
stop(Stop.BRAKE)
stop(Stop.HOLD)

becomes

stop()
brake()
hold()

This is easier to type and remember.
2020-03-17 15:19:55 +01:00
Laurens Valk a0fba6c2d1 api/builtins/Control: Move stalled to control
This is a control status property, so move it to the control class. This way, it is hidden from the common motor methods, and DriveBases will be able to use it too.
2020-02-17 13:55:45 +01:00
Laurens Valk 6278aeb1b6 doc/builtins: drop simplemotor
Now that we have reduced the complexity of the docstrings and after moving the control settings to a separate page, it is no longer necessary to have simplified motor docs.
2020-01-28 17:51:23 +01:00
Laurens Valk fe39782b5a config: rename _instances
Now that the instance hack has been dropped, all that remains is the simplified motor docs, so rename file accordingly.
2020-01-14 17:58:10 +01: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 8acab1898a doc: delete existing inline examples
Those should be included as working and tested Python files instead. They should be toggled on/off.
2019-12-09 14:31:53 +01:00
Laurens Valk 2e78033720 doc/devices: simplify motor docs, reduce detail
Previously, we simplified the docs for initializing a motor. This commit also simplifies the docstrings for common motor methods, by leaving out details and optional arguments. Full details are still available on the dedicated motor page.
2019-12-09 11:09:11 +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 4f25a0c467 doc/ev3devices: On EV3 docs, drop DC methods.
These can still be viewed on the full Motor class description. But on EV3, these functions are not so relevant as all motors have encoders.

Then we can also remove the encoded/encoderless rubric, further removing clutter.
2019-11-11 13:25:41 +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 f73e10b99b api: add EV3 Analog Sensor 2019-11-04 16:58:30 +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