doc: some organization and toc

This commit is contained in:
Laurens Valk
2018-12-31 12:54:04 +01:00
parent 56364997a2
commit c5288d34ac
9 changed files with 96 additions and 16 deletions
+17
View File
@@ -0,0 +1,17 @@
:mod:`ev3brick` -- The Programmable Brick
=========================================
.. automodule:: ev3brick
Buttons
-------
Light
-----
Sound
-----
Display
-------
+27 -4
View File
@@ -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
+19 -4
View File
@@ -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
+22 -5
View File
@@ -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
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`parameters` -- Title
==========================
:mod:`parameters` -- Parameters and Constants
=============================================
Intro
+1 -1
View File
@@ -1,4 +1,4 @@
Signals and units
Signals and Units
=================
Intro
+2
View File
@@ -0,0 +1,2 @@
Installing Pybricks
===================
+2
View File
@@ -0,0 +1,2 @@
Running a program
=================
+4
View File
@@ -0,0 +1,4 @@
:mod:`tools` -- Timing and Datalogging
======================================
Intro