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
740 Commits 10 Branches 125 Tags
@pybricks/ide-docs/v1.1.0
Commit Graph
386 Commits
Author SHA1 Message Date
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
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 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 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 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
Laurens Valk 69c32e5c0d doc: fix image paths 
Use full path just like all other images in the api docs
 2021-01-18 12:42:15 +01:00
Laurens Valk 14ad697565 doc/start_ev3: use rst files instead of inc 
Use standard sphinx conventions as much as possible.
 2021-01-18 12:00:38 +01:00
Laurens Valk d2a6b07e0c doc/start_ev3: move download link 2021-01-18 11:52:49 +01:00
Laurens Valk 853b141153 doc/start_ev3: group as folder 2021-01-18 11:52:24 +01:00
Laurens Valk 12a6b49f97 doc/frames: drop unused file 2021-01-18 11:13:51 +01:00
Laurens Valk 06c1d00f22 config: drop contentui plugin 
We are no longer using this
 2021-01-13 16:54:18 +01:00
Laurens Valk 8c0d7a3904 doc/parameters: drop content tabs for sides 2021-01-13 16:54:18 +01:00
Laurens Valk 9b5590047d doc/parameters: drop content tabs for ports 2021-01-13 16:54:28 +01:00
Laurens Valk 46d9e3c119 doc/iodevices: refactor 
Split all classes to their own file. This keeps things organized, and allows per-class comments about compatibility. Also flatten toggled examples.
 2021-01-13 16:54:18 +01:00
Laurens Valk bb7c9adbb8 doc/start_pup: drop toggles 2021-01-13 15:55:08 +01:00
Laurens Valk 5f4ef05c6e doc/tools: move data logging to separate page 
Expand the EV3 examples without toggles, and without making the tools page too long.
 2021-01-13 15:44:39 +01:00
Laurens Valk 5bbbff2550 doc/messaging: expand examples 
Drop use of toggle via plugin.
 2021-01-13 15:13:51 +01:00
Laurens Valk 8f637c52cd doc/media: drop toggle ui 2021-01-13 14:25:08 +01:00
Laurens Valk f826e7641c doc/media: footnote instead of toggle for language 
This is a way to make the language list non-distracting without the contentui plugin
 2021-01-12 16:50:43 +01:00
Laurens Valk 400067c364 doc/hubs/ev3brick: use footnote instead of toggle 
This is a way to make the language list non-distracting without the contentui plugin
 2021-01-12 16:50:18 +01:00
Laurens Valk 05ecf8bcb6 doc/hubs: show IMU on Prime and Technic Hub 2021-01-05 16:31:35 +01:00
Laurens Valk 1f991302e5 doc/common: fix unit of acceleration 2021-01-05 16:31:35 +01:00
Laurens Valk f3f0532f74 doc/hubs: move note about identical classes 
Otherwise, it was shown after the newly added __init__ docstring, which was confusing.
 2021-01-05 16:31:35 +01:00
Laurens Valk 64146f5afa doc/geometry: axis and orientation conventions 2021-01-05 16:31:21 +01:00
Laurens Valk e52130b627 api/hubs/inventorhub: enable IMU 
The minimal change to start reviewing and improving IMU api and docs.
 2021-01-04 17:25:16 +01:00
Laurens Valk a2583944d9 api/geometry: move Axis from parameters 
This location makes more sense. Also drop Axis.ANY = None, which is more confusing than helpful. Instead, use relevant docstring to explain what None will do.
 2021-01-04 17:25:15 +01:00