David Lechner
096e25b892
doc: custom branding is no longer required
...
Removed all of the envronment variable getting. All values that are used only once are no longer assigned to constant.
2019-02-27 17:25:25 -06:00
David Lechner
a42ae1d432
doc: enable external link styling on html output
2019-02-27 17:10:06 -06:00
David Lechner
2bea76d136
doc: add disclaimer to html doc output
2019-02-27 17:10:06 -06:00
David Lechner
df432d5252
doc: use project name and version for latex(pdf) file name
2019-02-20 18:59:55 -06:00
David Lechner
c3b5e52b5b
doc: allow branding of project name
2019-02-20 18:58:35 -06:00
David Lechner
79b2ded6f2
doc: fix dobule copyright in generated html docs
...
the html docs already include the copyright symbol and the word "Copyright", so we ended up with "© Copyright Copyright © 2018-2019 The Pybricks MicroPython Authors. "
drop it from the _COPYRIGHT setting and add it back into the disclaimer in the latex generated doc
2019-02-20 18:50:51 -06:00
Laurens Valk
924e866539
doc: separate images and labels
...
- remove quick draft images
- push plain screenshots and separate plain text svg files
- Update label content based on user feedback
- Cleaner label layout
- Use same fonts in labels as in text + better scaling
- basic automation of inkscape in travis; this probably needs some work. It should at least be moved into the make doc instead
2019-02-08 12:54:57 +01:00
Laurens Valk
0f6656ada1
doc: signal types
...
fixes #111
2019-02-07 12:29:42 +01:00
David Lechner
050302d6a1
doc: add logo to footer in pdf
2019-01-30 10:43:50 -06:00
David Lechner
bd94558375
doc: allow branding in title via environment variable
2019-01-25 11:12:04 -06:00
David Lechner
2e392e2312
doc: enable warnings as errors
...
This will let CI catch more problems. Fixes #104
Checking references had to be temporarily disabled because of temporarily disabled pages.
2019-01-24 16:34:24 -06:00
David Lechner
af6fdf9729
doc: clean up latex/pdf doc
...
- Override header and footer
- fixes warnings about even/odd pages
- adds disclaimer for LEGO trademarks
- rename "Release" to "Version"
- new title
- remove authors
2019-01-24 16:09:30 -06:00
Laurens Valk
ce1ec1cb55
doc: copyediting
2019-01-24 15:52:00 +01:00
David Lechner
cbefc64136
doc: add some Pybricks branding
...
This adds some Pybricks logos to the the generated docs .
The actual logos are quick hacks and should be revisited.
2019-01-20 19:10:26 -06:00
Laurens Valk
072ba814d7
doc: formatting
...
.
Remove empty pages
a few images were falling off the page because there wasn't any body text.
2019-01-18 16:50:07 +01:00
David Lechner
cccc9f9b46
Merge branch 'travis'
2019-01-15 21:42:00 -06:00
David Lechner
a15f3bc99a
use versioneer for setting python package version
...
https://github.com/warner/python-versioneer
😋 🍪
2019-01-15 20:58:43 -06:00
Laurens Valk
39eab3230e
doc: back to explicit ev3brick and ev3devices
...
(instead of brick and devices)
After internal discussion:
- This way we need to maintain only one fake API.
- Autocomplete can pick up the right brick/devices.
- Explicit is better than implicit.
2019-01-09 14:51:41 +01:00
Laurens Valk
d5dedc7924
doc: autodoc for init
...
test syntax for autolinking to types
test syntax to avoid evaluating enum arguments to numbers
2018-12-28 16:40:01 +01:00
Laurens Valk
fe82313bde
fake-api: parameters module (experimental)
...
Fix EV3 colors after recent pbio update
And make sphinx compile (but not much more)
2018-12-21 17:44:43 +01:00
David Lechner
54baebc1f5
doc: experimenting with autodoc generation
...
Observations:
* Type annotations tend to be verbose, for example:
blink(color1: typing.Union[pblight.Color, pblight.RGB, NoneType], color2: typing.Union[pblight.Color, pblight.RGB, NoneType], pattern: pblight.Pattern) → None
* There seems to be a bug with .. autodata::
2018-09-07 20:53:03 -05:00
David Lechner
e44d08a0f0
doc: relocate doc build files
2018-09-07 17:29:41 -05:00
David Lechner
Laurens Valk