Laurens Valk
c4b11fdb77
doc: placeholder lpf2docs
2019-04-19 17:50:09 +02:00
Laurens Valk
6278f2410d
doc: Separate common settings
2019-04-19 16:45:12 +02:00
Laurens Valk
1a4cdfaf50
doc: add instructions for opening existing project
2019-03-21 15:54:22 +01:00
Laurens Valk
7165d69517
doc: add figure caption top margin
...
also rename Fig. to Figure and add colon between Figure and the text:
(Figure X : Something) instead of (Fig. X Something)
Still one space to many, but better than no colon or margin at all
fixes #121
2019-03-01 16:51:46 +01:00
Laurens Valk
4e9e26753a
doc: add figure numbers and reference labels
...
fixes #131
2019-03-01 15:00:36 +01:00
Laurens Valk
0cc04f40b8
doc: add battery
...
Fixes #114
- reorganize common classes in fake API such as Display, Speaker and Battery.
- This does not change the user API
2019-03-01 14:25:56 +01:00
Laurens Valk
5dde48cc57
doc: nomenclature and registered signs
2019-02-28 17:50:26 +01:00
Laurens Valk
3a632dcd57
doc: languages and terminology
2019-02-28 17:48:14 +01:00
Laurens Valk and GitHub
eef65cb3eb
Merge pull request #125 from pybricks/enum
...
Enum
2019-02-28 12:09:14 +01:00
David Lechner
096e25b892
doc: custom branding is no longer required
...
Removed all of the envronment variable getting. All values that are used only once are no longer assigned to constant.
2019-02-27 17:25:25 -06:00
David Lechner
a42ae1d432
doc: enable external link styling on html output
2019-02-27 17:10:06 -06:00
David Lechner
2bea76d136
doc: add disclaimer to html doc output
2019-02-27 17:10:06 -06:00
David Lechner
317f68bf2d
ev3dev: rename Image and Sound parameters to ImageFile and SoundFile
2019-02-27 16:24:38 -06:00
Laurens Valk
d5527f84e3
doc/examples: update text
2019-02-25 18:24:22 +01:00
Anton and Laurens Valk
113dbe46de
docs/examples: expanded color sorter content
2019-02-25 18:12:54 +01:00
Anton and Laurens Valk
14b11dfe88
docs/examples: expanded educator robot content
2019-02-25 18:11:04 +01:00
Anton and Laurens Valk
8dbbd4e431
docs/robot arm: added explanation
2019-02-25 18:06:21 +01:00
Laurens Valk
2d2d365fb2
doc: run instructions update
...
based in part on 86f341d520838c43be57dc1a62937b1b8ade0520
2019-02-25 15:40:06 +01:00
Laurens Valk
4fb31688f7
doc: install update
...
based in part on e1f0ae450067ece3826e454d2df93436e11f9905
2019-02-25 15:12:53 +01:00
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
4a9ef64658
doc/installation: fixed build issues. Sorry.
2019-02-23 19:54:18 +01:00
Anton
a1d366f9c8
docs/creating&running: revised text for simplicity and ease of reading.
2019-02-23 19:13:07 +01:00
Anton
677b5b3647
docs/installation: revised text for simplicity and ease of reading.
2019-02-23 19:12:38 +01:00
Anton
082158d84a
docs: explained python vs micropython in introduction.
2019-02-23 19:11:53 +01:00
Anton
3cfc1d97ee
doc: makefile mac proof with abs path
2019-02-22 11:51:09 +01:00
Laurens Valk
579e46806c
robotics: DriveBase import and example
2019-02-21 15:07:16 +01:00
Laurens Valk
e75ad00e1c
doc: file manager
...
doc: basic drive base example
2019-02-21 15:06:10 +01:00
Laurens Valk
a5bfa06a5e
robotics: basic placeholder DriveBase class
2019-02-21 12:24:25 +01:00
Laurens Valk
822877c416
doc: fix svg reference
...
fixes #124 (I think)
2019-02-21 09:23:34 +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
df432d5252
doc: use project name and version for latex(pdf) file name
2019-02-20 18:59:55 -06:00
David Lechner
c3b5e52b5b
doc: allow branding of project name
2019-02-20 18:58:35 -06:00
David Lechner
79b2ded6f2
doc: fix dobule copyright in generated html docs
...
the html docs already include the copyright symbol and the word "Copyright", so we ended up with "© Copyright Copyright © 2018-2019 The Pybricks MicroPython Authors. "
drop it from the _COPYRIGHT setting and add it back into the disclaimer in the latex generated doc
2019-02-20 18:50:51 -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
443e986d82
doc: very rough run instructions
2019-02-20 21:39:41 +01: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
93fd0d7289
doc: images for run with brickman
2019-02-19 17:02:27 +01:00
Laurens Valk
302e8e6e2b
doc: test inclusion of getting started example
2019-02-19 15:57:43 +01:00
Laurens Valk
712ea78576
doc: store instructions
2019-02-19 15:21:08 +01:00
Laurens Valk
c9a53e8236
doc: getting started images
2019-02-19 12:43:38 +01:00
David Lechner
2b67a3a10d
doc: integrate image rendering into makefiles
...
This makes it so that `make -C doc` works to build all of the docs in a single command.
there are still a few problems with this:
1. the build does not fail if the correct fonts are not found
2. the images are only generated via the makefile, so trying to build the docs by other methods won't work
2019-02-08 13:25:55 -06:00
Laurens Valk
0423530af6
doc: create build directory for images with labels
2019-02-08 13:25:40 +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
Laurens Valk
7935a4ab57
doc: proposed API update for dc motor settings
2019-02-06 15:48:54 +01:00
David Lechner
050302d6a1
doc: add logo to footer in pdf
2019-01-30 10:43:50 -06:00
Laurens Valk
0125afd45b
doc: add image and sound file enums
...
fixes #94
bricks/ev3dev: static sound and image file enums
2019-01-29 11:00:30 +01:00
David Lechner
bd94558375
doc: allow branding in title via environment variable
2019-01-25 11:12:04 -06:00
Laurens Valk
David Lechner
AntonandLaurens Valk