Skip to content

Commit 1c67e2b

Browse files
committed
Provide documentation for RemoteControl class
Also fixes a couple of warnings from sphinx. Fixes #214
1 parent 6cf56b2 commit 1c67e2b

File tree

2 files changed

+41
-9
lines changed

2 files changed

+41
-9
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ Make sure that you look at the `User Resources`_ section as well for links
4545
to documentation and larger examples.
4646

4747
Usage Examples
48-
------------
48+
--------------
4949

5050
To run these minimal examples, run the Python3 interpreter from
5151
the terminal using the ``python3`` command:
5252

53-
.. code-block::
53+
.. code-block:: bash
5454
5555
$ python3
5656
Python 3.4.2 (default, Oct 8 2014, 14:47:30)

docs/other.rst

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,45 @@ Other classes
33

44
.. currentmodule:: ev3dev.core
55

6+
Remote Control
7+
--------------
8+
9+
.. autoclass:: RemoteControl
10+
:members:
11+
:inherited-members:
12+
13+
.. rubric:: Event handlers
14+
15+
These will be called when state of the corresponding button is changed:
16+
17+
.. py:data:: on_red_up
18+
.. py:data:: on_red_down
19+
.. py:data:: on_blue_up
20+
.. py:data:: on_blue_down
21+
.. py:data:: on_beacon
22+
23+
.. rubric:: Member functions and properties
24+
25+
Button
26+
------
27+
28+
.. autoclass:: ev3dev.ev3.Button
29+
:members:
30+
:inherited-members:
31+
32+
.. rubric:: Event handlers
33+
34+
These will be called when state of the corresponding button is changed:
35+
36+
.. py:data:: on_up
37+
.. py:data:: on_down
38+
.. py:data:: on_left
39+
.. py:data:: on_right
40+
.. py:data:: on_enter
41+
.. py:data:: on_backspace
42+
43+
.. rubric:: Member functions and properties
44+
645
Leds
746
----
847

@@ -44,13 +83,6 @@ Power Supply
4483
.. autoclass:: PowerSupply
4584
:members:
4685

47-
Button
48-
------
49-
50-
.. autoclass:: ev3dev.ev3.Button
51-
:members:
52-
:inherited-members:
53-
5486
Sound
5587
-----
5688

0 commit comments

Comments
 (0)