Commit Graph
203 Commits
Author SHA1 Message Date
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
Laurens Valk a627491dae config: do not hyperlink scaled images
This way, you don't go to another page if you accidentally click an image.

If someone really needs the original size, they can right click on the image and copy or just zoom in.
2020-04-07 15:34:15 +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 6ada01315d doc: add external link decoration to sidebar
External link decorations are already enabled in the documentation
content, but the RTD theme doesn't extend this to the sidebar. This
copies the css from the RTD theme and adds it to the sidebar.

This makes it less of a surprise when you click on a link and find
yourself on a completely different website.
2020-03-25 20:25:35 +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
Laurens Valk ada50328bb doc/pupdevices/Motor: fix reset_angle
The note about absolute angle support had accidentally ended up in the GyroSensor. It applies only to pupdevices.Motor.
2020-03-24 16:25:06 +01:00
Laurens Valk 3b76bbc424 config: add link to home page and downloads 2020-03-20 16:10:33 +01:00
Laurens Valk c78f4b04f9 config: fix pybricks logo
Use anti-aliasing
On blue backgrounds like rtd, logo is white and transparent
2020-03-20 15:58:20 +01:00
Laurens Valk a827491b2b doc/pupdevices: doc ColorDistanceSensor.remote() 2020-03-20 11:13:52 +01:00
Laurens Valk d36b5b0ed8 doc/nxtdevices: remove note about old touch sensor
Special treatment is no longer necessary; if no such touch sensor is detected, the port switches to analog mode.

This means that it will work for both touch sensor types, as well as custom switches.
2020-03-20 10:26:26 +01:00
David Lechner bea9a6216e config: update windows make.bat to match Makefile 2020-03-18 17:30:42 -05:00
David Lechner e3d0d51c9f config: drop versioneer
This removes versioneer for versioning. The version depends on the
pybricks-micropython version targeted so it doesn't make sense to use
automatic versioning here.
2020-03-18 17:30:42 -05:00
David Lechner 803c57aa8e config: html_context is no longer dependant on ON_RTD
This refactors duplicated code.
2020-03-18 14:03:50 -05:00
David Lechner e4d1547f83 doc: move css overrides to template
Hopefully this should fix small fonts when docs are published on RDT.org.
2020-03-18 13:51:24 -05:00
Laurens Valk aa343d017f doc/robotics: add note for when to change settings 2020-03-17 15:47:54 +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
David Lechner 0c611fabab doc/conf.py: add contentui css when building on readthedocs.org 2020-03-13 13:07:08 -05:00
David Lechner abe24cf289 api/builtin: add missing DCMotor.stop() method
This was missing. It also has a different default value
from the Motor class, so Motor overrides this method.
2020-03-12 12:52:27 -05:00
David Lechner cab16f6af7 api/media/ev3dev: add Image/screen save method
This was overlooked previously.
2020-03-06 12:59:42 -06:00
Laurens Valk ffae01fd0c config: move project specifics to own conf.py
Each target doc build can have it own parameters.
2020-03-05 14:07:31 +01:00
Laurens Valk a1dce8e50e config: use doc agnostic paths for images
Allow files like messaging .rst to be included without having to copy the images.
2020-03-05 13:05:34 +01:00