This makes it so that `make -C doc` works to build all of the docs in a single command.
there are still a few problems with this:
1. the build does not fail if the correct fonts are not found
2. the images are only generated via the makefile, so trying to build the docs by other methods won't work
- 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
- Override header and footer
- fixes warnings about even/odd pages
- adds disclaimer for LEGO trademarks
- rename "Release" to "Version"
- new title
- remove authors
This prevents warnings about the _static directory not existing. We will probably want to override something eventually, so adding an empty file rather than removing it from conf.py.
(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.
We should not encourage users to use the numerical values (i.e. 2 for Stop.hold or 65 for Port.A)
This also keeps the door open for using qstrings for some enums (Color, Button).
Sphinx and read the docs seem to require RST. This works well for this sample code.
Unfortunately, vscode code preview seems to require markdown (For the tables. Other RST seems to work.)
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::
Laurens Valk
David Lechner