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