Commit Graph
183 Commits
Author SHA1 Message Date
Laurens Valk 6bc394bdcd doc/start_ev3_brick: doc8 2020-05-19 11:32:25 +02:00
Laurens Valk 10bceb970e doc/ev3: doc8 for inc files 2020-05-19 11:27:50 +02:00
Laurens Valk b0e5ae9f0f config: do not spell sphinx directives 2020-05-19 11:20:18 +02:00
Laurens Valk 92745f1921 doc/start_ev3: add upgrade guide
Explain how existing users can benefit from the update
2020-05-19 10:49:04 +02:00
David Lechner cce1149db6 doc: fix latexpdf build
Building pdf was broken because of chinese characters in one of the
code snippets.

LaTeX stack exchange recommends use XeTeX engine instead but this
causes other formatting problems (like footer using wide font) so
just hacking this in for now.
2020-05-18 16:01:10 -05:00
Laurens Valk dbbbe29201 doc/ev3_install: update download link 2020-05-05 17:19:39 +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 81fa637f0b doc/robotics: add note for using individual motors 2020-05-01 15:08:21 +02:00
Laurens Valk a74afd9ed4 doc/robotics: move advanced settings to bottom 2020-05-01 15:07:57 +02:00
Laurens Valk 4ca568079e doc/robotics: clarify wheel_diameter, axle_track
Add tips for practical experiments to validate the dimensions
2020-04-28 17:09:43 +02:00
Laurens Valk 350b90d967 doc/parameters: document stop types in table
Make more explicit how the stop types gradually add more resistance to motion.
2020-04-28 14:01:28 +02:00
Laurens Valk c6f7b514ec doc: remove ascii art for motor directions
We have actual graphics of motors with their default clockwise directions now, so refer to those instead.
2020-04-28 13:27:51 +02:00
Laurens Valk 0db7ccb36a doc/ev3_linux: describe command line, set hostname 2020-04-28 12:47:40 +02:00
Laurens Valk 0cc1583313 doc/messaging: describe pairing process 2020-04-28 12:47:40 +02:00
Laurens Valk 3296abc8cb doc/ev3: diagram to show how to get command line 2020-04-28 12:47:40 +02:00
Laurens Valk 33d6f39b6b doc/messaging: add connection screenshots 2020-04-28 12:47:40 +02:00
David Lechner ada455247f doc/media: fix fc-list command
This specifying dpi in the fc-list command filters out all results.
2020-04-24 09:57:53 -05:00
Laurens Valk 17731a024f doc/media: document how to use the font commands
These commands are run on the command line, not a user script, so explain how to access it.
2020-04-24 12:29:14 +02:00
Laurens Valk 3a2980d3b9 doc/media: remove emphasis on font config
Bright colored boxes are reserved for things that deserve extra emphasis
like warnings. They should not be used for extras like tips and
footnotes, especially if aimed at a very small percentage of users.
2020-04-24 12:07:18 +02:00
Laurens Valk 4de436e479 doc/motors: hide extra sections until ready
Avoid references to non-existing explanations.
2020-04-24 12:00:26 +02:00
Laurens Valk 05ea3654ec doc/tools: link to file manager
Now that the EV3 starter guide is back, we can refer to it instead of
including a duplicate image of the ev3dev file browser.
2020-04-16 15:13:46 +02:00
Laurens Valk 2a96106a9d pybricks-projects: update data log example
Bring in update to project settings.
2020-04-16 15:09:44 +02:00
Laurens Valk d0a9e7ca95 doc/api/start_ev3: relative path for labeled image 2020-04-16 14:25:00 +02:00
Laurens Valk 82b01451b1 doc/images: add plain green sensor 2020-04-16 14:18:54 +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
David Lechner e18b4370a2 doc: add html sound player for sound preview
This adds an in-browser preview for all sounds without having to
download them first.
2020-04-14 15:17:15 -05:00
David Lechner 512c1fa4b1 doc: fix duplicate thumbs up/down
Thumbs down was listed twice and in one case it had the wrong image.
2020-04-14 15:06:57 -05:00
Laurens Valk 6f8e3ba0ff doc/tools: improve datalog information
- Fix typo in example
- Explain how to upload a log file
- Show an example graph
2020-04-10 13:54:36 +02:00
Laurens Valk 5e921680ab doc/hubs: add Move Hub motor default directions 2020-04-08 11:09:30 +02:00
Laurens Valk 88ffa6c902 doc/media: add sound previews 2020-04-08 10:01:43 +02:00
Laurens Valk 3277382d03 doc/media: add ev3dev-media
Add previews for images
2020-04-08 10:01:43 +02:00
David Lechner f51a25c051 doc: add tip on Fontconfig
For users who want to understand how fonts work under the hood.
2020-04-08 09:58:13 +02:00
David Lechner 402991fce8 config: add support for inkscape 1.x
There are breaking command line option changes between 0.9.x and 1.x.
2020-04-02 20:44:36 -05:00
Laurens Valk dfbda2dd69 doc/robotics: update heading
Make it consistent with the other pages
2020-04-01 13:49:09 +02:00
Laurens Valk 01e3466ed5 doc/index: add link to example projects 2020-04-01 13:48:01 +02:00
Laurens Valk 85c2d28959 doc/nxtdevices: add sensor icons 2020-03-27 14:50:20 +01:00
Laurens Valk f5c3ee6ab7 doc/ev3devices: add sensor icons 2020-03-27 14:50:06 +01:00
Laurens Valk cd5e589494 doc/iodevices: add icons 2020-03-27 14:17:07 +01:00
Laurens Valk 2bdc975f8b doc/ev3devices: add motor icons with directions 2020-03-27 14:16:43 +01:00
David Lechner ffb950869c Add EV3 screen examples
This includes examples from the pybricks-projects repository
2020-03-26 13:58:02 +01:00
Laurens Valk 95e808df9d doc/pupdevices: add sensor icons
Only the ColorDistanceSensor is added to the docs for now. Other icons are included for future use.
2020-03-25 20:30:34 +01:00
Laurens Valk d6b20a962c doc/media: make module level match
ImageFile and SoundFile are located at media.ev3dev, not media.
2020-03-25 20:30:34 +01: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 9e1134b4e9 doc/messaging: add simpler diagram
also restyle to match examples included in the docs.
2020-03-25 20:30:34 +01:00
Laurens Valk a308524289 doc/hubs: add hub icons to toggle menu
Also add icons for hubs we might support one day.
2020-03-25 20:30:33 +01:00
Laurens Valk 3b61cc81d2 doc/pupdevices: dc motors with default directions 2020-03-25 20:30:33 +01:00
Laurens Valk 73a41beeb4 doc/pupdevices: add motors with default directions 2020-03-25 20:27:51 +01:00
David Lechner 87c2b6857f api: Use leading _ to hide internals in intellisense
Intellisense in VS Code (both jedi and ms python language server) picks
up all imported names and suggests them with equal priority for
code completion. By adding a leading underscore, intellisense lists
these with a lower priority, so they don't get in the way.

Also rename from builtins to _common while we are touching this to
better reflect the intention of the module (it contains types shared
by multiple modules, not builtin types like int).
2020-03-25 20:24:32 +01:00