diff --git a/docs/EV3.rst b/docs/EV3.rst new file mode 100644 index 0000000000000000000000000000000000000000..bb679dc88652edb9e25f3339b2407d052e4307f5 --- /dev/null +++ b/docs/EV3.rst @@ -0,0 +1,12 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +EV3 +=== + +.. autoclass:: EV3 + :members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties + + diff --git a/docs/Motor.rst b/docs/Motor.rst new file mode 100644 index 0000000000000000000000000000000000000000..4e89a896e0b6aeccef31836a19ee29d3dd73eeb9 --- /dev/null +++ b/docs/Motor.rst @@ -0,0 +1,10 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +Motor +===== + +.. autoclass:: Motor + :members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties diff --git a/docs/Sensor.rst b/docs/Sensor.rst new file mode 100644 index 0000000000000000000000000000000000000000..0404ade83e4643e3b8dd830a8b428f1b06dfd4fa --- /dev/null +++ b/docs/Sensor.rst @@ -0,0 +1,10 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +Sensor +====== + +.. autoclass:: Sensor + :members: reset, setProperties diff --git a/docs/conf.py b/docs/conf.py index e09d3c575df98cad20545f3d4eeb5588104a5221..1685a350b23b229ac2ff2b83029a20959cec59bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 = [] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000000000000000000000000000000000000..b90c0e1cba794d0c4c0d5679dba4cb0fb9fc4ef6 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,3 @@ +======== +Examples +======== diff --git a/docs/index.rst b/docs/index.rst index 32339b8c15a093a9abd83ae2f95e974280f64bda..4ebb311f2fe3915e3d5b5dba277214e1933c6419 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 - source + readme + examples +Toolbox documentation -Indices and tables -================== +.. toctree:: + :maxdepth: 2 + + EV3 + Motor + Sensor + +Advanced + +.. toctree:: + :maxdepth: 2 -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000000000000000000000000000000000000..ddcfba5efbf31886070e6c0c8f8f87190c277a21 --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1,12 @@ +======= +General +======= + +Installation +============ + +Contribution +============ + +Licenses +======== diff --git a/docs/source.rst b/docs/source.rst index 589e1dd71f965275426b905e185bec519a40f781..bb679dc88652edb9e25f3339b2407d052e4307f5 100644 --- a/docs/source.rst +++ b/docs/source.rst @@ -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 -