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
747 Commits 10 Branches 125 Tags
3229da030b3ebf98981b0edebdb6e95c7ccd49e4
Commit Graph
50 Commits
Author SHA1 Message Date
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
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 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 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 06c1d00f22 config: drop contentui plugin 
We are no longer using this
 2021-01-13 16:54:18 +01:00
Laurens Valk ede503f6fe config: rename CPlusHub to TechnicHub 
This replaces the name in internal files.
 2020-10-09 19:16:33 +02:00
Laurens Valk 282e34b9e0 config: add pybricks-color directive 
This directive produces a small box with the color from the Pybricks API:

.. pybricks-color:: CYAN
 2020-08-12 12:19:49 +02:00
David Lechner 3554814c86 config: add Pybricks favicon 2020-06-17 13:38:22 -05:00
David Lechner 70cc605b56 config: update version to 3.0 
We are working on the v3.0 release now.
 2020-06-17 13:04:06 -05:00
David Lechner cce1149db6 doc: fix latexpdf build 
Building pdf was broken because of chinese characters in one of the
code snippets.

LaTeX stack exchange recommends use XeTeX engine instead but this
causes other formatting problems (like footer using wide font) so
just hacking this in for now.
 2020-05-18 16:01:10 -05:00
Laurens Valk a627491dae config: do not hyperlink scaled images 
This way, you don't go to another page if you accidentally click an image.

If someone really needs the original size, they can right click on the image and copy or just zoom in.
 2020-04-07 15:34:15 +02:00
David Lechner 6ada01315d doc: add external link decoration to sidebar 
External link decorations are already enabled in the documentation
content, but the RTD theme doesn't extend this to the sidebar. This
copies the css from the RTD theme and adds it to the sidebar.

This makes it less of a surprise when you click on a link and find
yourself on a completely different website.
 2020-03-25 20:25:35 +01:00
David Lechner 87c2b6857f api: Use leading _ to hide internals in intellisense 
Intellisense in VS Code (both jedi and ms python language server) picks
up all imported names and suggests them with equal priority for
code completion. By adding a leading underscore, intellisense lists
these with a lower priority, so they don't get in the way.

Also rename from builtins to _common while we are touching this to
better reflect the intention of the module (it contains types shared
by multiple modules, not builtin types like int).
 2020-03-25 20:24:32 +01:00
Laurens Valk 3b76bbc424 config: add link to home page and downloads 2020-03-20 16:10:33 +01:00
Laurens Valk c78f4b04f9 config: fix pybricks logo 
Use anti-aliasing
On blue backgrounds like rtd, logo is white and transparent
 2020-03-20 15:58:20 +01:00
David Lechner e3d0d51c9f config: drop versioneer 
This removes versioneer for versioning. The version depends on the
pybricks-micropython version targeted so it doesn't make sense to use
automatic versioning here.
 2020-03-18 17:30:42 -05:00
David Lechner 803c57aa8e config: html_context is no longer dependant on ON_RTD 
This refactors duplicated code.
 2020-03-18 14:03:50 -05:00
David Lechner e4d1547f83 doc: move css overrides to template 
Hopefully this should fix small fonts when docs are published on RDT.org.
 2020-03-18 13:51:24 -05:00
David Lechner 0c611fabab doc/conf.py: add contentui css when building on readthedocs.org 2020-03-13 13:07:08 -05:00
Laurens Valk ffae01fd0c config: move project specifics to own conf.py 
Each target doc build can have it own parameters.
 2020-03-05 14:07:31 +01:00
Laurens Valk 8861be68eb config: remove diagram builder from common 
This has no image targets, so remove to avoid confusion.
 2020-03-04 11:43:37 +01:00
David Lechner b1382f02b0 move EV3 mailboxes to ev3messaging module 
- add separate maibox classes
- drop bluetooth module since it is not considered public API
 2020-02-12 09:55:28 +01:00
David Lechner 7acbcbd874 initial EV3 bluetooth mailbox docs 2020-02-12 09:55:28 +01:00
David Lechner d9089bcbae api/media/ev3dev: update for Image API changes 2020-02-11 11:43:54 -06:00
David Lechner dc82ccce40 resources renamed to media.ev3dev 2020-01-14 17:32:40 -06:00
David Lechner 0398d04af9 pybricks/resources/image: add show_image() method 2020-01-13 20:12:50 -06:00
David Lechner c3e74273d2 pybricks/builtins: update Speaker docs 2020-01-13 12:59:21 -06:00
David Lechner b4cd9113b5 doc/api/hubs_ev3brick: add Image class as EV3Brick.screen 
This duplicates the Image class documentation In pybricks.ev3devices
as EV3Bricks.screen.
 2020-01-13 12:59:07 -06:00
Laurens Valk 5991fb544b config: fix contentui css 
The contentui sets the page with to be infinite in order to add a second column.

We do not use this feature, so we set the width back to normal.  Also make sure our theme_overrides are last in conf.py to make sure they override the contentui css.
 2020-01-13 14:44:11 +01:00
David Lechner 31a639f55b doc/api/conf.py: enable nitpicky 
This enables the sphinx doc nitpicky option to detect broken references.

Also fix all of the broken references.
 2020-01-11 21:08:20 -06:00
Laurens Valk 613998661e config: fix contentui css 
The extension CSS does not get included correctly. Fix html context so we don't have to copy the css.
 2019-12-09 17:08:12 +01:00
Laurens Valk ea1d19b66d doc: resolve css conflict 2019-10-19 21:52:51 +02:00
Laurens Valk 2307a20cf0 doc: simplify module toc 2019-10-19 21:18:59 +02:00
Laurens Valk 372e5ccbd0 doc: single api target 
Also delete getting started instructions
 2019-10-18 18:11:57 +02:00
Laurens Valk a728edb8ad doc: style tweaks 2019-10-18 14:43:43 +02:00
Laurens Valk 240d21bcca api: split frame configuration into method 
Because the __init__ for built-in IMUs won't be called
by the user.
 2019-07-02 12:59:21 +02:00
Laurens Valk e453cecb2e api: accelerometer drafts 2019-07-02 11:57:00 +02:00
Laurens Valk f6eb7674a9 conf: drop references to future work 2019-06-11 20:05:40 +02:00
Laurens Valk b92eb447b4 doc: add extra units 2019-06-08 11:57:12 +02:00
Laurens Valk 0013a74d72 drop class method identifier from docs 
Same result as in 92e3735d63, but now achieved by patching the Sphinx configuration instead of patching the API.

Now it doesn't break the API for the purpose of checking and autocomplete, etc.
 2019-06-05 13:57:04 +02:00
Laurens Valk 28a5329bb6 api/doc: pybricks is a package 2019-06-05 12:47:24 +02:00
Laurens Valk 8d37450fac api: flake8 2019-06-04 15:45:36 +02:00
Laurens Valk 0d3b682223 doc: doc8 2019-06-04 14:47:52 +02:00
Laurens Valk c43d296511 doc: move snippets to doc 
Example snippets are platform specific.
 2019-06-03 12:02:16 +02:00
David Lechner 668b7a43a9 doc: fix include path for api 
fix breakage causes by 3091489843
 2019-05-09 11:38:42 -05:00
Laurens Valk 3a42c8f870 Update config paths 
This makes the docs build again:
cd doc
make SOURCEDIR=ev3dev html
make SOURCEDIR=lpf2 html
 2019-05-09 14:40:05 +02:00
Laurens Valk c950bf1d8e import api documentation 2019-05-09 13:23:26 +02:00