Commit Graph
33 Commits
Author SHA1 Message Date
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
Laurens Valk bcf610a29e doc/index: regroup hubs by platform
Make it easier to pick the right installation guide.
2020-10-25 19:51:40 +01:00
Laurens Valk 55001644d2 doc/start_inventor: add placeholder quick start
This adds an empty page so we can link to it from the main page.
2020-10-25 19:49:18 +01:00
Laurens Valk ede503f6fe config: rename CPlusHub to TechnicHub
This replaces the name in internal files.
2020-10-09 19:16:33 +02:00
Laurens Valk 24d35993e9 api: rename CPlusHub to TechnicHub
This reflects the newly adopted naming convention.

See https://github.com/pybricks/support/issues/119
2020-10-09 19:16:33 +02:00
Laurens Valk ce087f5330 doc/index: fix pup link 2020-06-05 15:56:04 +02:00
Laurens Valk 4c6984bf16 doc/index: add link to about Pybricks page 2020-05-05 15:37:40 +02:00
Laurens Valk 1c28b5821d doc/index: add basic welcome page 2020-05-05 15:23:49 +02:00
Laurens Valk 840e45c078 doc: add placeholder Powered Up quick start guide 2020-04-16 14:13:51 +02:00
Laurens Valk 0a54671b78 doc: bring back EV3 quick start guide
This brings back, updates, and reorganizes the EV3 getting started sections.

- Brought back from older v1.0 docs
- Updated with new labeled screenshots for Visual Studio Code
- Reorganized under EV3 Quick Start heading. This lets us add a similar guide for Powered Up.
2020-04-16 14:13:51 +02:00
Laurens Valk 01e3466ed5 doc/index: add link to example projects 2020-04-01 13:48:01 +02:00
Laurens Valk 2e4274995d doc/messaging: extend introduction.
Also drop separate, nearly empty Mailboxes page. Ultimately we may separate this page into two pieces again, but for now a single concise page is clearer than two incomplete pages.
2020-03-25 20:30:34 +01:00
Laurens Valk 3b76bbc424 config: add link to home page and downloads 2020-03-20 16:10:33 +01:00
David Lechner f8ccbb7896 api/messaging: rename ev3messaging module to messaging 2020-02-12 09:55:28 +01:00
David Lechner b1382f02b0 move EV3 mailboxes to ev3messaging module
- add separate maibox classes
- drop bluetooth module since it is not considered public API
2020-02-12 09:55:28 +01:00
David Lechner 7acbcbd874 initial EV3 bluetooth mailbox docs 2020-02-12 09:55:28 +01:00
Laurens Valk 6525fbc98a doc/frames: hide page
This won't be needed until support for accelerometers is added.
2020-01-28 20:28:29 +01:00
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