diff --git a/source/ev3brick.rst b/source/ev3brick.rst new file mode 100644 index 0000000..7d87be6 --- /dev/null +++ b/source/ev3brick.rst @@ -0,0 +1,17 @@ +:mod:`ev3brick` -- The Programmable Brick +========================================= + +.. automodule:: ev3brick + + +Buttons +------- + +Light +----- + +Sound +----- + +Display +------- diff --git a/source/ev3devices.rst b/source/ev3devices.rst index ce4b8f4..7fa8cb8 100644 --- a/source/ev3devices.rst +++ b/source/ev3devices.rst @@ -1,7 +1,30 @@ -:mod:`ev3devices` -- Title -========================== +:mod:`ev3devices` -- Motors and Sensors +=========================================== -Intro +Motors +------ -.. automodule:: ev3devices +.. autoclass:: ev3devices.Motor +Sensors +------- + +Touch Sensor +^^^^^^^^^^^^ +.. autoclass:: ev3devices.TouchSensor + +Color Sensor +^^^^^^^^^^^^ +.. autoclass:: ev3devices.ColorSensor + +Infrared Sensor and Beacon +^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. autoclass:: ev3devices.InfraredSensor + +Ultrasonic Sensor +^^^^^^^^^^^^^^^^^ +.. autoclass:: ev3devices.UltrasonicSensor + +Gyroscopic Sensor +^^^^^^^^^^^^^^^^^ +.. autoclass:: ev3devices.GyroSensor diff --git a/source/index.rst b/source/index.rst index f5f8780..14d60b6 100644 --- a/source/index.rst +++ b/source/index.rst @@ -7,13 +7,28 @@ Welcome to Pybricks's documentation! ==================================== .. toctree:: - :maxdepth: 2 - :caption: Pybricks: + :maxdepth: 1 + :caption: Getting started: - parameters + startinstall + startrun + + +.. toctree:: + :maxdepth: 1 + :caption: Modules: + + ev3brick ev3devices - signaltypes + parameters + tools +.. toctree:: + :maxdepth: 1 + :caption: Engineering essentials: + + signaltypes + motorcontrol Indices and tables diff --git a/source/motorcontrol.rst b/source/motorcontrol.rst index 3e14fbb..c8fd757 100644 --- a/source/motorcontrol.rst +++ b/source/motorcontrol.rst @@ -1,23 +1,40 @@ -Basic motor functions +Motor Essentials ===================== Intro -PID Parameters --------------- +Encoded Motors +---------------- + .. _duty: Duty cycle ----------- +^^^^^^^^^^ TODO +Angle encoder +^^^^^^^^^^^^^ +TODO + + + +Motor maneuvers +--------------- + + +Reference signal +^^^^^^^^^^^^^^^^ + + +Automatic control +^^^^^^^^^^^^^^^^^ .. _pid: PID Parameters --------------- +^^^^^^^^^^^^^^ TODO diff --git a/source/parameters.rst b/source/parameters.rst index fc592cb..4b8c262 100644 --- a/source/parameters.rst +++ b/source/parameters.rst @@ -1,5 +1,5 @@ -:mod:`parameters` -- Title -========================== +:mod:`parameters` -- Parameters and Constants +============================================= Intro diff --git a/source/signaltypes.rst b/source/signaltypes.rst index 349b773..90fa87e 100644 --- a/source/signaltypes.rst +++ b/source/signaltypes.rst @@ -1,4 +1,4 @@ -Signals and units +Signals and Units ================= Intro diff --git a/source/startinstall.rst b/source/startinstall.rst new file mode 100644 index 0000000..4e10e4c --- /dev/null +++ b/source/startinstall.rst @@ -0,0 +1,2 @@ +Installing Pybricks +=================== diff --git a/source/startrun.rst b/source/startrun.rst new file mode 100644 index 0000000..084aef2 --- /dev/null +++ b/source/startrun.rst @@ -0,0 +1,2 @@ +Running a program +================= diff --git a/source/tools.rst b/source/tools.rst new file mode 100644 index 0000000..fcf8505 --- /dev/null +++ b/source/tools.rst @@ -0,0 +1,4 @@ +:mod:`tools` -- Timing and Datalogging +====================================== + +Intro