doc: back to explicit ev3brick and ev3devices

(instead of brick and devices)

After internal discussion:
- This way we need to maintain only one fake API.
- Autocomplete can pick up the right brick/devices.
- Explicit is better than implicit.
This commit is contained in:
Laurens Valk
2019-01-09 14:51:41 +01:00
parent 2f0d7ec0a2
commit 39eab3230e
6 changed files with 88 additions and 87 deletions
-55
View File
@@ -1,55 +0,0 @@
:mod:`brick` -- The EV3 Programmable Brick
==========================================
Buttons
-------
.. autofunction:: brick.buttons
Light
-----
.. autofunction:: brick.light
Sound
-----
.. automethod:: brick.sound.beep
.. automethod:: brick.sound.beeps
.. automethod:: brick.sound.tune
.. automethod:: brick.sound.file
.. automethod:: brick.sound.speak
Display
-------
::
x
-------------->
(0, 0) __________________
| |
| | |
y | | Hello |
| | World |
v | |
|__________________|
(177, 127)
.. automethod:: brick.display.clear
.. automethod:: brick.display.text
.. automethod:: brick.display.image
+1
View File
@@ -90,6 +90,7 @@ todo_include_todos = True
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members']
autoclass_content = 'both' # This ensures init arguments are not ignored but added to class docstring.
add_module_names = False # Hide module name
# -- Options for HTML output ----------------------------------------------
-30
View File
@@ -1,30 +0,0 @@
:mod:`devices` -- EV3 Motors and Sensors
===========================================
Motors
------
.. autoclass:: devices.Motor
Sensors
-------
Touch Sensor
^^^^^^^^^^^^
.. autoclass:: devices.TouchSensor
Color Sensor
^^^^^^^^^^^^
.. autoclass:: devices.ColorSensor
Infrared Sensor and Beacon
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: devices.InfraredSensor
Ultrasonic Sensor
^^^^^^^^^^^^^^^^^
.. autoclass:: devices.UltrasonicSensor
Gyroscopic Sensor
^^^^^^^^^^^^^^^^^
.. autoclass:: devices.GyroSensor
+55
View File
@@ -0,0 +1,55 @@
:mod:`ev3brick` -- The EV3 Programmable Brick
=============================================
Buttons
-------
.. autofunction:: ev3brick.buttons
Light
-----
.. autofunction:: ev3brick.light
Sound
-----
.. automethod:: ev3brick.sound.beep
.. automethod:: ev3brick.sound.beeps
.. automethod:: ev3brick.sound.tune
.. automethod:: ev3brick.sound.file
.. automethod:: ev3brick.sound.speak
Display
-------
::
x
-------------->
(0, 0) __________________
| |
| | |
y | | Hello |
| | World |
v | |
|__________________|
(177, 127)
.. automethod:: ev3brick.display.clear
.. automethod:: ev3brick.display.text
.. automethod:: ev3brick.display.image
+30
View File
@@ -0,0 +1,30 @@
:mod:`ev3devices` -- EV3 Motors and Sensors
===========================================
Motors
------
.. 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
+2 -2
View File
@@ -18,8 +18,8 @@ Welcome to Pybricks's documentation!
:maxdepth: 1
:caption: Modules:
brick
devices
ev3brick
ev3devices
parameters
tools