Files
pybricks-api/source/index.rst
T
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

37 lines
617 B
ReStructuredText

.. Pybricks documentation master file, created by
sphinx-quickstart on Thu Sep 6 15:31:12 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Pybricks's documentation!
====================================
.. toctree::
:maxdepth: 2
:caption: Basics:
repl
.. toctree::
:maxdepth: 2
:caption: Device-specific modules:
modmovehub
.. toctree::
:maxdepth: 2
:caption: Common modules:
modpblight
modutime
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`