Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 09:37:25 +00:00
Code Issues Releases Activity
214 Commits 10 Branches 125 Tags
aa8c95234ef5bd26bb8657cd067bbc59cd2ce8a5
Commit Graph
214 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
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 312b2a4818 robotics: basic placeholder DriveBase class 2019-02-21 12:24:25 +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 78bb431bc0 doc: fix duty setting 
fixes #118
 2019-02-19 21:24:05 +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 08990f6342 doc: images for run with brickman 2019-02-19 17:02:27 +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 e35c0ddb12 motorcontrol: partial terminology update for duty steps 
when we add an offset internally, the argument isn't really duty cycle anymore. This could use some further work.

Offsets are still zero by default.
 2019-02-07 10:16:59 +01:00
Laurens Valk 7935a4ab57 doc: proposed API update for dc motor settings 2019-02-06 15:48:54 +01:00
Laurens Valk 5894852ebf 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 d273a5fea9 bricks/ev3dev: make gyro api same as motor 
and add calibrate and reset_angle methods

speed, angle, reset_angle and direction are now the same as in a motor
 2019-01-29 11:38:56 +01: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
Laurens Valk 5639d02daf 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
David Lechner b3f9ae659e fake-pybricks: don't quote strings in setup.cfg 
this is an ini file, not a python file

also run `python3 versioneer.py setup` to apply changes
 2019-01-24 19:51:33 -06:00
David Lechner 2e392e2312 doc: enable warnings as errors 
This will let CI catch more problems. Fixes #104

Checking references had to be temporarily disabled because of temporarily disabled pages.
 2019-01-24 16:34:24 -06:00
David Lechner 79056f1092 fake-pybricks: fix comments in example too long for pdf docs 
in the pdf docs, the comment lines were too long and caused the line to be wrapped which doesn't make for easy reading
 2019-01-24 16:16:17 -06: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
David Lechner eae359ee42 doc: fix module index 
some modules were missing because of missing automodule directive
 2019-01-24 16:10:11 -06:00
David Lechner af6fdf9729 doc: clean up latex/pdf doc 
- Override header and footer
    - fixes warnings about even/odd pages
    - adds disclaimer for LEGO trademarks
- rename "Release" to "Version"
- new title
- remove authors
 2019-01-24 16:09:30 -06:00
Laurens Valk 25f0aa24d8 doc: remove unwritten intro 2019-01-24 16:12:38 +01:00
Laurens Valk cec568c454 doc: copyediting 2019-01-24 15:52:00 +01:00
Laurens Valk ce1ec1cb55 doc: copyediting 2019-01-24 15:52:00 +01:00
Laurens Valk 5f65f842ad Merge branch 'run_until_stalled' and 'motor-lock' 2019-01-23 21:43:39 +01:00
Laurens Valk b1edd667e5 modmotor: respect previously specified stall limits 2019-01-23 21:11:51 +01:00
David Lechner c83e7d3a7d doc: make all the examples say "Example:" 2019-01-21 22:20:13 -06:00
David Lechner 2acc07d0d2 doc: update for directory name changes in examples submodule 2019-01-21 20:16:00 -06:00
Laurens Valk 59be0dab18 doc: remove todo note 2019-01-21 18:32:02 +01:00
David Lechner cbefc64136 doc: add some Pybricks branding 
This adds some Pybricks logos to the the generated docs .

The actual logos are quick hacks and should be revisited.
 2019-01-20 19:10:26 -06:00
David Lechner 48d795ea08 doc: add dummy file so we stop getting warnings 
This prevents warnings about the _static directory not existing. We will probably want to override something eventually, so adding an empty file rather than removing it from conf.py.
 2019-01-20 19:02:33 -06:00
Laurens Valk 18652e0639 doc: update robot arm name and references 2019-01-19 18:22:01 +01:00