diff --git a/doc/main/ev3devices.rst b/doc/main/ev3devices.rst index 79a797f..9fbc695 100644 --- a/doc/main/ev3devices.rst +++ b/doc/main/ev3devices.rst @@ -1,4 +1,4 @@ -:mod:`ev3devices ` -- EV3 Devices +:mod:`ev3devices ` -- EV3 devices ====================================================== .. automodule:: pybricks.ev3devices diff --git a/doc/main/hubs/index.rst b/doc/main/hubs/index.rst index 3e88e9f..c4d410f 100644 --- a/doc/main/hubs/index.rst +++ b/doc/main/hubs/index.rst @@ -1,6 +1,6 @@ .. pybricks-requirements:: -:mod:`hubs ` -- Programmable Hubs +:mod:`hubs ` -- Programmable hubs ================================================ .. module:: pybricks.hubs diff --git a/doc/main/index.rst b/doc/main/index.rst index 5b2df40..7c11ca1 100644 --- a/doc/main/index.rst +++ b/doc/main/index.rst @@ -65,13 +65,13 @@ Pybricks Documentation Use the ☰ menu to navigate all available classes, methods, and tools. A few commonly used devices and classes are listed below for quick reference. - .. rubric:: Programmable Hubs + .. rubric:: Programmable hubs .. figure:: ../main/images/hubsoverview.png :width: 100 % :target: hubs/index.html - .. rubric:: Powered Up Motors and Sensors + .. rubric:: Powered Up motors and sensors .. figure:: ../main/images/pupdevicesoverview.png :width: 100 % @@ -88,7 +88,7 @@ Pybricks Documentation .. toctree:: :maxdepth: 1 - :caption: Table of Contents + :caption: Table of contents :hidden: .. toctree:: @@ -96,12 +96,12 @@ Pybricks Documentation :caption: Pybricks :hidden: - Home Page + Home page Installation .. toctree:: :maxdepth: 1 - :caption: Pybricks Package + :caption: Pybricks modules :hidden: hubs/index @@ -115,7 +115,7 @@ Pybricks Documentation .. toctree:: :maxdepth: 1 - :caption: MicroPython Modules + :caption: MicroPython modules :hidden: micropython/builtins diff --git a/doc/main/iodevices/index.rst b/doc/main/iodevices/index.rst index 0cfd930..ebbbbb2 100644 --- a/doc/main/iodevices/index.rst +++ b/doc/main/iodevices/index.rst @@ -1,6 +1,6 @@ .. pybricks-requirements:: pybricks-iodevices -:mod:`iodevices ` -- Generic I/O Devices +:mod:`iodevices ` -- Generic I/O devices ============================================================ .. module:: pybricks.iodevices diff --git a/doc/main/media.rst b/doc/main/media.rst index b249d16..5472354 100644 --- a/doc/main/media.rst +++ b/doc/main/media.rst @@ -1,4 +1,4 @@ -:mod:`media ` -- Sounds and Images +:mod:`media ` -- Sounds and images ================================================== .. module:: pybricks.media @@ -18,7 +18,7 @@ and sound files. You can access them using the classes below. You can also use your own sound and image files by placing them in your project folder. -Image Files +Image files ^^^^^^^^^^^ .. autoclass:: pybricks.media.ev3dev.ImageFile @@ -223,7 +223,7 @@ Image Files .. image:: ../../media/ev3dev-media/images/mono/eyes/winking.png :width: 15 % -Sound Files +Sound files ^^^^^^^^^^^ .. autoclass:: pybricks.media.ev3dev.SoundFile @@ -1452,7 +1452,7 @@ Fonts .. _FontConfig: https://www.freedesktop.org/wiki/Software/fontconfig/ -Image Manipulation +Image manipulation ^^^^^^^^^^^^^^^^^^ Instead of drawing directly on the EV3 screen, you can make and interact diff --git a/doc/main/messaging.rst b/doc/main/messaging.rst index 2ae5137..3f1ce35 100644 --- a/doc/main/messaging.rst +++ b/doc/main/messaging.rst @@ -107,13 +107,13 @@ numbers, or text), you can choose one of the Mailboxes below. Examples ----------------- -**EV3 Bluetooth Server** +**EV3 Bluetooth server** This is the full version of the excerpt shown in :numref:`fig_messaging`. .. literalinclude:: ../../examples/ev3/bluetooth_server/server.py -**EV3 Bluetooth Client** +**EV3 Bluetooth client** This is the full version of the excerpt shown in :numref:`fig_messaging`. diff --git a/doc/main/nxtdevices.rst b/doc/main/nxtdevices.rst index b84da5f..3285e76 100644 --- a/doc/main/nxtdevices.rst +++ b/doc/main/nxtdevices.rst @@ -1,4 +1,4 @@ -:mod:`nxtdevices ` -- NXT Devices +:mod:`nxtdevices ` -- NXT devices ====================================================== .. automodule:: pybricks.nxtdevices diff --git a/doc/main/parameters/index.rst b/doc/main/parameters/index.rst index d1b7b89..2bd592c 100644 --- a/doc/main/parameters/index.rst +++ b/doc/main/parameters/index.rst @@ -1,6 +1,6 @@ .. pybricks-requirements:: -:mod:`parameters ` -- Parameters and Constants +:mod:`parameters ` -- Parameters and constants =================================================================== .. automodule:: pybricks.parameters diff --git a/doc/main/pupdevices/dcmotor.rst b/doc/main/pupdevices/dcmotor.rst index 73396d1..0046aba 100644 --- a/doc/main/pupdevices/dcmotor.rst +++ b/doc/main/pupdevices/dcmotor.rst @@ -1,6 +1,6 @@ .. pybricks-requirements:: -Motors without Rotation Sensors +Motors without rotation sensors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _fig_pupdcmotors: diff --git a/doc/main/pupdevices/index.rst b/doc/main/pupdevices/index.rst index 0550ae8..cfa5062 100644 --- a/doc/main/pupdevices/index.rst +++ b/doc/main/pupdevices/index.rst @@ -1,6 +1,6 @@ .. pybricks-requirements:: -:mod:`pupdevices ` -- Powered Up Devices +:mod:`pupdevices ` -- Powered Up devices ============================================================= .. automodule:: pybricks.pupdevices diff --git a/doc/main/pupdevices/motor.rst b/doc/main/pupdevices/motor.rst index 77beb0b..020f6d9 100644 --- a/doc/main/pupdevices/motor.rst +++ b/doc/main/pupdevices/motor.rst @@ -1,6 +1,6 @@ .. pybricks-requirements:: -Motors with Rotation Sensors +Motors with rotation sensors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _fig_pupmotors: @@ -78,7 +78,7 @@ Motors with Rotation Sensors .. automethod:: pybricks.pupdevices.Motor.control.stall_tolerances -Initialization Examples +Initialization examples ----------------------- Making the motor move back and forth @@ -105,7 +105,7 @@ Using gears .. literalinclude:: ../../../examples/pup/motor/motor_init_gears.py -Measurement Examples +Measurement examples ----------------------- Measuring the angle and speed @@ -121,7 +121,7 @@ Resetting the measured angle ../../../examples/pup/motor/motor_reset_angle.py -Movement Examples +Movement examples ----------------------- Basic usage of all run methods @@ -142,7 +142,7 @@ Using the ``then`` argument to change how a run command stops .. literalinclude:: ../../../examples/pup/motor/motor_action_then.py -Stall Examples +Stall examples ----------------------- Running a motor until a mechanical endpoint @@ -158,7 +158,7 @@ Centering a steering mechanism ../../../examples/pup/motor/motor_until_stalled.py -Parallel Movement Examples +Parallel movement examples -------------------------- Using the ``wait`` argument to run motors in parallel diff --git a/doc/main/robotics.rst b/doc/main/robotics.rst index 92ea752..6665c90 100644 --- a/doc/main/robotics.rst +++ b/doc/main/robotics.rst @@ -88,7 +88,7 @@ To deactivate the :class:`.DriveBase`, call :meth:`.stop`. - .. rubric:: Advanced Settings + .. rubric:: Advanced settings The :meth:`.settings` method is used to adjust commonly used settings like the default speed and acceleration for straight maneuvers and turns.