Commit Graph
25 Commits
Author SHA1 Message Date
Laurens Valk 15b2aab8a5 doc: terminology and nomenclature
- EV3 brick
- MicroPython
- microSD card
- EV3 MicroPython microSD card image
2019-02-25 14:04:21 +01:00
Laurens Valk f568e01c1f doc: Revert doc changes on master
This reverts commits
2d3a4f43369fa65f8c07bfe5ea013cac26a9a571
86f341d520838c43be57dc1a62937b1b8ade0520
e1f0ae450067ece3826e454d2df93436e11f9905
4e34704a5bd0b0774acbe7cf5167e754313c0290
2019-02-25 10:54:41 +01:00
Anton 082158d84a docs: explained python vs micropython in introduction. 2019-02-23 19:11:53 +01:00
Laurens Valk 579e46806c robotics: DriveBase import and example 2019-02-21 15:07:16 +01:00
Laurens Valk a5bfa06a5e robotics: basic placeholder DriveBase class 2019-02-21 12:24:25 +01:00
David Lechner 97d8536862 doc: move introduction before toctree
This fixes the introduction text appearing at the end of the pdf doc instead of at the begining. Also use rubric directive instead of sections so that these headings don't appear in the TOC (and mess up the heading levels).

https://stackoverflow.com/q/25276415/1976323
2019-02-20 20:07:19 -06:00
David Lechner 1bca2706af doc: add dummy empty toctree directive
This adds an empty toctree directive with the caption "Table of Contents" so that the latexpdf build says "Table of Contents" on the TOC instead of "Getting Started".
2019-02-20 18:36:08 -06:00
David Lechner 6ca0465322 docs: drop autogenerated comment
this doesn't tell us anything useful, so remove it
2019-02-20 18:31:56 -06:00
Laurens Valk a7913baffc doc: draft text for install page
and EV3 brick usage instruction pictures
2019-02-19 21:18:19 +01:00
Laurens Valk 924e866539 doc: separate images and labels
- remove quick draft images
- push plain screenshots and separate plain text svg files
- Update label content based on user feedback
- Cleaner label layout
- Use same fonts in labels as in text + better scaling
- basic automation of inkscape in travis; this probably needs some work. It  should at least be moved into the make doc instead
2019-02-08 12:54:57 +01:00
Laurens Valk 0f6656ada1 doc: signal types
fixes #111
2019-02-07 12:29:42 +01:00
David Lechner d3475f7870 doc: fix module index
some modules were missing because of missing automodule directive
2019-01-24 16:10:11 -06:00
Laurens Valk ce1ec1cb55 doc: copyediting 2019-01-24 15:52:00 +01:00
David Lechner 2acc07d0d2 doc: update for directory name changes in examples submodule 2019-01-21 20:16:00 -06:00
Laurens Valk 18652e0639 doc: update robot arm name and references 2019-01-19 18:22:01 +01:00
Laurens Valk 1918adf7b4 doc: remove vscode instructions for first release
add examples instead

users can use their favorite method of getting the examples or their own scripts to the brick
2019-01-19 17:31:45 +01:00
Laurens Valk 8a133b8101 doc: test instructions 2019-01-16 21:29:19 +01:00
Laurens Valk 39eab3230e doc: back to explicit ev3brick and ev3devices
(instead of brick and devices)

After internal discussion:
- This way we need to maintain only one fake API.
- Autocomplete can pick up the right brick/devices.
- Explicit is better than implicit.
2019-01-09 14:51:41 +01:00
Laurens Valk 2f0d7ec0a2 doc: brick, sound, display, and experiment with samples 2019-01-04 15:05:17 +01:00
Laurens Valk c5288d34ac doc: some organization and toc 2018-12-31 12:54:04 +01:00
Laurens Valk 7c106e2444 doc: experiment with signal types 2018-12-29 13:02:59 +01:00
Laurens Valk d5dedc7924 doc: autodoc for init
test syntax for autolinking to types
test syntax to avoid evaluating enum arguments to numbers
2018-12-28 16:40:01 +01:00
Laurens Valk fe82313bde fake-api: parameters module (experimental)
Fix EV3 colors after recent pbio update

And make sphinx compile (but not much more)
2018-12-21 17:44:43 +01:00
David Lechner 54baebc1f5 doc: experimenting with autodoc generation
Observations:

* Type annotations tend to be verbose, for example:

        blink(color1: typing.Union[pblight.Color, pblight.RGB, NoneType], color2: typing.Union[pblight.Color, pblight.RGB, NoneType], pattern: pblight.Pattern) → None

* There seems to be a bug with .. autodata::
2018-09-07 20:53:03 -05:00
David Lechner e44d08a0f0 doc: relocate doc build files 2018-09-07 17:29:41 -05:00