Skip to content

Commit edb32cb

Browse files
ddemidovddemidov
committed
Restructure documentation
Split index.rst into several subdocuments: motors sensors other classes Use the autogen system to generate list of the special sensors.
1 parent e627510 commit edb32cb

File tree

10 files changed

+245
-163
lines changed

10 files changed

+245
-163
lines changed

‎autogen-config.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"ev3dev/core.py",
44
"ev3dev/ev3.py",
55
"ev3dev/brickpi.py",
6-
"spec_version.py"
6+
"spec_version.py",
7+
"docs/sensors.rst"
78
],
89
"templateDir": "templates/"
910
}

‎docs/index.rst‎

Lines changed: 4 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -5,128 +5,12 @@
55
66
.. include:: ../README.rst
77

8-
Module interface
9-
----------------
8+
.. rubric:: Contents
109

11-
.. automodule:: ev3dev.ev3
12-
13-
.. autosummary::
14-
:nosignatures:
15-
16-
Device
17-
Motor
18-
DcMotor
19-
ServoMotor
20-
MediumMotor
21-
LargeMotor
22-
Sensor
23-
I2cSensor
24-
TouchSensor
25-
ColorSensor
26-
UltrasonicSensor
27-
GyroSensor
28-
SoundSensor
29-
LightSensor
30-
InfraredSensor
31-
RemoteControl
32-
Led
33-
Leds
34-
PowerSupply
35-
Button
36-
Sound
37-
Screen
38-
39-
Generic device
40-
^^^^^^^^^^^^^^
41-
42-
.. autoclass:: Device
43-
:members:
44-
45-
Motors
46-
^^^^^^
47-
48-
.. autoclass:: Motor
49-
:members:
50-
51-
.. autoclass:: MediumMotor
52-
:members:
53-
:show-inheritance:
54-
55-
.. autoclass:: LargeMotor
56-
:members:
57-
:show-inheritance:
58-
59-
.. autoclass:: DcMotor
60-
:members:
61-
62-
.. autoclass:: ServoMotor
63-
:members:
64-
65-
Sensors
66-
^^^^^^^
67-
68-
.. autoclass:: Sensor
69-
:members:
70-
71-
.. autoclass:: I2cSensor
72-
:members:
73-
:show-inheritance:
74-
75-
.. autoclass:: TouchSensor
76-
:members:
77-
:show-inheritance:
78-
79-
.. autoclass:: ColorSensor
80-
:members:
81-
:show-inheritance:
82-
83-
.. autoclass:: UltrasonicSensor
84-
:members:
85-
:show-inheritance:
86-
87-
.. autoclass:: GyroSensor
88-
:members:
89-
:show-inheritance:
90-
91-
.. autoclass:: SoundSensor
92-
:members:
93-
:show-inheritance:
94-
95-
.. autoclass:: LightSensor
96-
:members:
97-
:show-inheritance:
98-
99-
.. autoclass:: InfraredSensor
100-
:members:
101-
:show-inheritance:
102-
103-
.. autoclass:: RemoteControl
104-
:members:
105-
:inherited-members:
106-
107-
Other
108-
^^^^^
109-
110-
.. autoclass:: Led
111-
:members:
112-
113-
.. autoclass:: Leds
114-
:members:
115-
116-
.. autoclass:: PowerSupply
117-
:members:
118-
119-
.. autoclass:: Button
120-
:members:
121-
:inherited-members:
122-
123-
.. autoclass:: Sound
124-
:members:
125-
126-
.. autoclass:: Screen
127-
:members:
128-
:show-inheritance:
10+
.. toctree::
11+
:maxdepth: 3
12912

13+
spec
13014

13115
Indices and tables
13216
==================

‎docs/motors.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Motor classes
2+
=============
3+
4+
.. currentmodule:: ev3dev.core
5+
6+
Tacho motor
7+
-----------
8+
9+
.. autoclass:: Motor
10+
:members:
11+
12+
Large EV3 Motor
13+
---------------
14+
15+
.. autoclass:: LargeMotor
16+
:members:
17+
:show-inheritance:
18+
19+
Medium EV3 Motor
20+
----------------
21+
22+
.. autoclass:: MediumMotor
23+
:members:
24+
:show-inheritance:
25+
26+
DC Motor
27+
--------
28+
29+
.. autoclass:: DcMotor
30+
:members:
31+
32+
Servo Motor
33+
-----------
34+
35+
.. autoclass:: ServoMotor
36+
:members:

‎docs/other.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Other classes
2+
=============
3+
4+
.. currentmodule:: ev3dev.core
5+
6+
Leds
7+
---
8+
9+
.. autoclass:: Led
10+
:members:
11+
12+
.. autoclass:: Leds
13+
:members:
14+
15+
Power Supply
16+
------------
17+
18+
.. autoclass:: PowerSupply
19+
:members:
20+
21+
Button
22+
------
23+
24+
.. autoclass:: Button
25+
:members:
26+
:inherited-members:
27+
28+
Sound
29+
-----
30+
31+
.. autoclass:: Sound
32+
:members:
33+
34+
Screen
35+
------
36+
37+
.. autoclass:: Screen
38+
:members:
39+
:show-inheritance:
40+

‎docs/sensors.rst‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
Sensor classes
2+
==============
3+
4+
Sensor
5+
------
6+
7+
This is the base class all the other sensor classes are derived from.
8+
9+
.. currentmodule:: ev3dev.core
10+
11+
.. autoclass:: Sensor
12+
:members:
13+
14+
Special sensor classes
15+
----------------------
16+
17+
The classes derive from :py:class:`Sensor` and provide helper functions
18+
specific to the corresponding sensor type. Each of the functions makes
19+
sure the sensor is in the required mode and then returns the specified value.
20+
21+
.. ~autogen doc-special-sensor-classes
22+
23+
Touch Sensor
24+
########################
25+
26+
.. autoclass:: TouchSensor
27+
:members:
28+
:show-inheritance:
29+
30+
31+
32+
Color Sensor
33+
########################
34+
35+
.. autoclass:: ColorSensor
36+
:members:
37+
:show-inheritance:
38+
39+
40+
41+
Ultrasonic Sensor
42+
########################
43+
44+
.. autoclass:: UltrasonicSensor
45+
:members:
46+
:show-inheritance:
47+
48+
49+
50+
Gyro Sensor
51+
########################
52+
53+
.. autoclass:: GyroSensor
54+
:members:
55+
:show-inheritance:
56+
57+
58+
59+
Infrared Sensor
60+
########################
61+
62+
.. autoclass:: InfraredSensor
63+
:members:
64+
:show-inheritance:
65+
66+
67+
68+
Sound Sensor
69+
########################
70+
71+
.. autoclass:: SoundSensor
72+
:members:
73+
:show-inheritance:
74+
75+
76+
77+
Light Sensor
78+
########################
79+
80+
.. autoclass:: LightSensor
81+
:members:
82+
:show-inheritance:
83+
84+
85+
86+
87+
.. ~autogen
88+

‎docs/spec.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
API reference
2+
=============
3+
4+
Each class in ev3dev module inherits from the base :py:class:`Device` class.
5+
6+
.. autoclass:: ev3dev.core.Device
7+
8+
.. rubric:: Contents:
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
13+
motors
14+
sensors
15+
other

‎ev3dev-lang‎

0 commit comments

Comments
 (0)