Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity
753 Commits 10 Branches 125 Tags
0082f0502a4f9d809dfe9831c8665aef1f067ee6
Commit Graph
753 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Laurens Valk 0082f0502a doc/parameters/Direction: move doc to rst 2021-02-14 18:44:25 +01:00
Laurens Valk e7dc4bb609 doc/parameters/Side: move doc to rst 2021-02-14 18:41:17 +01:00
Laurens Valk fb86e4bcef doc/parameters/Stop: fix typo 2021-02-14 16:21:37 +01:00
Laurens Valk 632908f59a doc/parameters: split out page per class 2021-02-14 16:06:23 +01:00
Laurens Valk 4a7fa12eaa config: add classlink directive 
We have index pages for most modules now, which link to individual classes. It is helpful if these empty class headers are hyperlinks. This commit does just that.

For most sensors/devices so far this is not really necessary as the images are already hyperlinks. But this will become more useful as we start adding index pages like these for classes without images, such as parameters.
 2021-02-14 15:39:39 +01:00
Jorge Pereira 109fcf19c1 examples/pup/motor: update motor_action_basic 
Demo of run_angle had a typo
 2021-02-14 13:54:58 +01:00
Laurens Valk 3229da030b doc/start_pup: update getting started instructions 2021-02-14 12:41:05 +01:00
Laurens Valk 4b052fa66d doc/pupdevices/motor: drop image alignment 
Fixes https://github.com/pybricks/pybricks-api/issues/40
 2021-02-12 11:10:51 +01:00
Laurens Valk 3c6ebd09bd doc/parameters/Color: add examples 2021-02-12 10:53:40 +01:00
Laurens Valk af1b84afe2 api/parameters/Color: drop name attribute 2021-02-12 10:16:43 +01:00
Laurens Valk 45dbd7db5a config: display border around white div 
Makes it easier to see white box on white background.
 2021-02-12 10:15:58 +01:00
Laurens Valk a7699d6546 api/common/Control: add load method 2021-02-10 18:49:51 +01:00
Laurens Valk 55c83cb026 api/common: add torque limit setter 
Also document units of torque
 2021-02-10 15:48:56 +01:00
David Lechner deb211bdb7 @pybricks/ide-docs v1.1.0 @pybricks/ide-docs/v1.1.0 2021-01-28 12:31:19 -06:00
David Lechner 8a5e5c3fb4 doc/ide: styling to match Pybricks Code 
We were injecting this from Pybricks code, but it caused the scroll bars
to flash when loading a page.
 2021-01-28 12:31:19 -06:00
ZPhilo 2a1640f7dc examples/pup/hubs/hub_primehub: fix button 
Corrected Bluetooth button name (from BT to BLUETOOTH)
 2021-01-28 09:31:41 +01:00
Laurens Valk 535aac8144 config: fix missing automembers in sphinx upgrade 
This setting was renamed and should now be a dictionary.

Fixes https://github.com/pybricks/pybricks-api/issues/45
 2021-01-28 09:30:23 +01:00
David Lechner 00cc5ee44e poetry: move dev dependencies to dev section 
Users who install this package from PyPi don't need all of the dev dependencies.
 2021-01-26 11:46:32 -06:00
Laurens Valk f0b882b576 config: update to Sphinx 3.4 2021-01-26 09:18:13 +01:00
Laurens Valk 8ed45aecfb doc/nxtdevices: drop method link 
For some reason, these are not working after upgrading to Sphinx 3.X, even though the same reference to conversion works just fine elsewhere.
 2021-01-26 09:07:19 +01:00
David Lechner 77605e8701 github: add workflow for publishing ide-docs package 2021-01-26 08:30:48 +01:00
David Lechner b4c8242133 doc/ide: add node package 
This will be used to publish the docs in a way that is easy for
pybricks-code to use.
 2021-01-26 08:30:48 +01:00
David Lechner 06e01e5ac8 doc/ide: use sphinx.ext.imgmath 
MathJax uses a CDN to to distribute the package. So in order to use the
docs offline, we would have to include our own copy. But it is a bit
large (50-ish MB), so it is easier to use sphinx.ext.imgmath instead
to generate svg images.

The situation might be different with MathJax v3, but that requires
Sphinx v4.
 2021-01-26 08:30:48 +01:00
David Lechner ff22c32c24 doc/api/signaltypes: use ^{\circ} instead of ° in :math: 
This works for both sphinx.ext.mathjax and sphinx.ext.imgmath.
 2021-01-26 08:30:48 +01:00
David Lechner 95eb999493 doc/api/signaltypes: fix degree symbol overlapping 
The degree symbol was a bit too close to the letters.
 2021-01-26 08:30:48 +01:00
David Lechner 7d729a8e9e doc/ide: hide the "view source" link 
Since these are meant to be offline docs and use a smaller screen area
we can omit this to keep things cleaner.
 2021-01-26 08:30:48 +01:00
David Lechner c750a3cd88 doc/ide: hide prev/next buttons 
In the IDE this is more of a reference and less of a book so going to
the next page doesn't make as much sense.
 2021-01-26 08:30:48 +01:00
David Lechner adf6e03bc9 doc: open external links in a new window 
This adds a hack to open external links in a new window. Requires Sphinx v1.8.
 2021-01-26 08:30:48 +01:00
David Lechner 0466ce947f doc: override external link style on figure target 
This works around https://github.com/readthedocs/sphinx_rtd_theme/pull/494#issuecomment-354063112
 2021-01-26 08:30:48 +01:00
David Lechner 7abb670f66 doc/ide: hide footers 
This information is duplicated in the IDE about dialog so we don't need
it in the docs.
 2021-01-26 08:30:48 +01:00
Laurens Valk 55d7a8a254 examples/pup: acceleration and angular velocity 2021-01-20 16:02:36 +01:00
Laurens Valk e051455e23 examples/pup: add imu tilt examples 2021-01-20 14:55:27 +01:00
Laurens Valk 4b5b97bbb2 examples/pup: add imu up() example 2021-01-20 11:13:24 +01:00
Laurens Valk 1573508f75 examples/pup/primehub: auto rotate display 2021-01-20 11:05:09 +01:00
Laurens Valk 018b0d8b9d examples: simplify hub script generator 
Instead of saying that some lines should be skipped, just say for which hubs the entire script will work.
 2021-01-20 10:56:21 +01:00
Laurens Valk 47d7fa46d8 examples: drop common inventorhub scripts 
The doc page has been merged into one page, with all examples using the PrimeHub class.
 2021-01-20 10:40:26 +01:00
Laurens Valk 21e5400ff3 api/common/IMU: publish draft API 2021-01-19 15:09:06 +01:00
Laurens Valk bb77e0f413 doc/hubs: link inventorhub to primehub 2021-01-19 11:45:14 +01:00
Laurens Valk c5851a3569 doc/ide: add landing page images 2021-01-19 11:42:21 +01:00
Laurens Valk 93f27f61e7 doc/hubs: make naming consistent 2021-01-19 11:19:39 +01:00
Laurens Valk 7d40e07dfb doc/hubs: InventorHub and PrimeHub on same page 
Make it a bit more explicit that they are the same.
 2021-01-19 11:18:21 +01:00
Laurens Valk 5ab71de988 doc/ide: improve landing page 
Add visuals to quickly get to hubs or pupdevices. These still need to be made into smaller more generic images, but these will do for now.
 2021-01-18 16:34:10 +01:00
Laurens Valk d7254472f0 doc/ide: simplify landing page and menu 
The embedded docs will only have the module documentation. Remove everything else.
 2021-01-18 16:33:14 +01:00
Laurens Valk 245542ce4d doc/iodevices/PUPDevice: move compatibility note 2021-01-18 16:33:14 +01:00
Laurens Valk 31891d0970 doc/ide: Drop EV3 pages 2021-01-18 16:33:14 +01:00
Laurens Valk 3cc9ec157e doc/api: avoid more ev3 references 2021-01-18 16:33:05 +01:00
Laurens Valk 9aa00fac15 doc/parameters: generalize Direction info 
Avoid links to EV3-specifics, because they may not be present in some builds.
 2021-01-18 15:36:07 +01:00
Laurens Valk 2a2ba8c6aa config: build both targets on CI 2021-01-18 14:36:13 +01:00
Laurens Valk db4cbe66c1 all: update copyright year 2021-01-18 14:34:28 +01:00
Laurens Valk 087dab5ed1 doc/ide: add build target for Pybricks Code 
poetry run make -C doc SOURCEDIR=ide html

This adds a build target for docs to integrate in Pybricks Code. This commit makes the build target produce an identical copy, by making each page reference its original rst file.

Now we can easily exclude certain components (such as EV3) as needed for Pybricks Code, and also change the main index / welcome page.
 2021-01-18 12:50:27 +01:00