Skip to content
Snippets Groups Projects
Commit d99ff88a authored by Tim Stadtmann's avatar Tim Stadtmann
Browse files

Rework structure of HTML-documentation

parent 58971a60
No related branches found
No related tags found
No related merge requests found
.. automodule:: source
.. |br| raw:: html
<br />
EV3
===
.. autoclass:: EV3
:members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties
.. automodule:: source
.. |br| raw:: html
<br />
Motor
=====
.. autoclass:: Motor
:members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties
.. automodule:: source
.. |br| raw:: html
<br />
Sensor
======
.. autoclass:: Sensor
:members: reset, setProperties
......@@ -157,7 +157,8 @@ html_theme = 'bootstrap'
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
html_theme_options = {'navbar_fixed_top': True,
'bootswatch_theme': "readable"}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
......
========
Examples
========
......@@ -3,21 +3,48 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Toolbox for controlling Lego Mindstorms EV3 with MATLAB
=======================================================
==================================================
MATLAB Toolbox for controlling Lego Mindstorms EV3
==================================================
Contents:
This MATLAB toolbox was designed to abstract and simplify controlling Lego Mindstorms
EV3 robots. Via Bluetooth or USB you can read sensor values or control
your robots' motors in an intuitive way. On a low level (the ##hyperlink## Communication
layer) you are able to send various commands directly to the brick, while on a high level,
several classes abstract this behaviour for you. If you want to easily access your EV3 robot,
these are the classes you will mostly use.
Take a look at the ##link to readme## for installation instructions.
This toolbox is being developed at the RWTH Aachen, Germany, as part of the students' lab
##hyperlink## 'MATLAB meets Mindstorms'. It is the follow-up of the widely used ##hyperlink## MATLAB NXT Toolbox.
##image##
Contents
========
Setting up the toolbox
.. toctree::
:maxdepth: 4
:maxdepth: 2
readme
examples
source
Toolbox documentation
.. toctree::
:maxdepth: 2
EV3
Motor
Sensor
Advanced
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
=======
General
=======
Installation
============
Contribution
============
Licenses
========
......@@ -10,16 +10,3 @@ EV3
:members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties
Motor
=====
.. autoclass:: Motor
:members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties
Sensor
======
.. autoclass:: Sensor
:members: reset, setProperties
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment