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
796 Commits 10 Branches 125 Tags
@pybricks/ide-docs/v1.4.0
Commit Graph
425 Commits
Author SHA1 Message Date
Laurens Valk cb84ca87c6 @pybricks/ide-docs v1.4.0 2021-06-23 19:56:31 +02:00
Laurens Valk e1995f9d1b ide: Display note about beta version. 2021-06-23 19:50:51 +02:00
Laurens Valk 7f0b1489a2 ide: Re-enable 3.X features. 
These were hidden for the 3.0 release, but we can re-enable them for
the beta release of 3.1.

Revert "v3: Drop parameters Side and Button."

This reverts commit 07c53e9a3d.

Revert "v3: Drop Remote control."

This reverts commit b600f5029e.

Revert "v3: Drop geometry module."

This reverts commit 5f767f3fee.

Revert "v3: Drop Prime Hub and Inventor Hub."

This reverts commit 8db7892f8c.

Revert "v3: Drop IMU documentation."

This reverts commit b325bf4bff.
 2021-06-23 19:41:15 +02:00
Laurens Valk aa2019be02 @pybricks/ide-docs v1.3.3 2021-06-23 19:36:00 +02:00
Laurens Valk 1ac78b5b82 @pybricks/ide-docs v1.3.2 2021-06-23 19:35:59 +02:00
Laurens Valk 847a3d5eec @pybricks/ide-docs v1.3.1 2021-06-23 19:35:59 +02:00
Laurens Valk 1a208ddd25 @pybricks/ide-docs v1.3.0 2021-06-23 19:35:59 +02:00
Laurens Valk 07c53e9a3d v3: Drop parameters Side and Button. 2021-06-23 19:35:58 +02:00
Laurens Valk b600f5029e v3: Drop Remote control. 2021-06-23 19:35:58 +02:00
Laurens Valk 5f767f3fee v3: Drop geometry module. 2021-06-23 19:35:57 +02:00
Laurens Valk 8db7892f8c v3: Drop Prime Hub and Inventor Hub. 2021-06-23 19:35:57 +02:00
Laurens Valk b325bf4bff v3: Drop IMU documentation. 
This is not officially supported yet, so drop from release docs.
 2021-06-23 19:35:57 +02:00
David Lechner 5d355e9892 doc/api/media: fix audio playback 
Sphinx changed how filenames are generated which broke media playback.
The file name now includes the MD5 hash of the filename passed to the
:download: directive.

This was done with the following script:

    for f in $(find media/ev3dev-media/ -name "*.wav" -exec bash -c 'echo "$(echo -n ../../'{}' | md5sum)/$(basename '{}')"' \;); do
        sed -i "s,_downloads/$(basename $f),_downloads/$f," doc/api/media.rst;
    done
 2021-06-04 12:45:44 -05:00
Laurens Valk 3b20a811cb examples/pup/motor_dc: Add battery box example. 2021-05-21 14:00:57 +02:00
Laurens Valk 790fcfa66a examples/pup/iodevices: Add PUPDevice example. 2021-04-29 13:03:34 +02:00
David Lechner d108d7c163 doc/common/conf: use xcode syntax highlighting 
This matches the style used in Pybricks Code.
 2021-04-28 15:54:11 -05:00
David Lechner d0bfbcb4d1 js: only apply target="_blank" to IDE build 
On the web, we want to be able to navigate between the various Pybricks
subdomains without opening new tabs. But Pybricks Code is treated as an
"app", we don't want links to open in Pybricks Code.
 2021-04-20 12:38:33 -05:00
Laurens Valk ca96ee2fce examples: Update detectable colors API. 2021-04-10 15:31:28 +02:00
Laurens Valk 597b6d682f @pybricks/ide-docs v1.2.0 2021-04-09 12:31:37 +02:00
Laurens Valk 9c8d41efb8 doc/index: Update install note in IDE docs. 2021-04-09 12:21:47 +02:00
Laurens Valk a06e01c6de doc/start_pup/ev3: Drop installation guide. 
These are now at https://pybricks.com/install/
 2021-04-07 19:56:56 +02:00
Laurens Valk 7679b8b47d examples/hubs/MoveHub: imu examples 2021-02-17 23:31:19 +01:00
Laurens Valk c14f1cf473 api/hubs/MoveHub: add basic imu 
This is similar to the other hubs, but with reduced functionality.
 2021-02-17 23:23:40 +01:00
Laurens Valk c46b249c8c @pybricks/ide-docs v1.1.1 2021-02-14 19:32:52 +01:00
Laurens Valk 67008b67d8 doc/ide: include installation guide 2021-02-14 19:26:10 +01:00
Laurens Valk 9c1beef6b6 doc/parameters/Port: move doc to rst 2021-02-14 19:00:52 +01:00
Laurens Valk 5eb7a143fa doc/parameters/Stop: move doc to rst 2021-02-14 19:00:52 +01:00
Laurens Valk fc04059d86 doc/parameters/Button: move doc to rst 2021-02-14 19:00:45 +01:00
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
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 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 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
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 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