doc: make all titles sentence case

This makes the casing of titles consistent throughout the docs. Fixes: https://github.com/pybricks/pybricks-api/issues/75
2026-09-12 01:24:17 +00:00 · 2021-11-19 19:30:57 -06:00
parent 2f574e8c03
commit 20cb5fdde5
12 changed files with 26 additions and 26 deletions
@@ -1,4 +1,4 @@
-:mod:`ev3devices <pybricks.ev3devices>` -- EV3 Devices
+:mod:`ev3devices <pybricks.ev3devices>` -- EV3 devices
 ======================================================

 .. automodule:: pybricks.ev3devices
@@ -1,6 +1,6 @@
 .. pybricks-requirements::

-:mod:`hubs <pybricks.hubs>` -- Programmable Hubs
+:mod:`hubs <pybricks.hubs>` -- Programmable hubs
 ================================================

 .. module:: pybricks.hubs
@@ -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 <https://pybricks.com>
+    Home page <https://pybricks.com>
    Installation <https://pybricks.com/install/>

 .. 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
@@ -1,6 +1,6 @@
 .. pybricks-requirements:: pybricks-iodevices

-:mod:`iodevices <pybricks.iodevices>` -- Generic I/O Devices
+:mod:`iodevices <pybricks.iodevices>` -- Generic I/O devices
 ============================================================

 .. module:: pybricks.iodevices
@@ -1,4 +1,4 @@
-:mod:`media <pybricks.media>` -- Sounds and Images
+:mod:`media <pybricks.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
@@ -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`.

@@ -1,4 +1,4 @@
-:mod:`nxtdevices <pybricks.nxtdevices>` -- NXT Devices
+:mod:`nxtdevices <pybricks.nxtdevices>` -- NXT devices
 ======================================================

 .. automodule:: pybricks.nxtdevices
@@ -1,6 +1,6 @@
 .. pybricks-requirements::

-:mod:`parameters <pybricks.parameters>` -- Parameters and Constants
+:mod:`parameters <pybricks.parameters>` -- Parameters and constants
 ===================================================================

 .. automodule:: pybricks.parameters
@@ -1,6 +1,6 @@
 .. pybricks-requirements::

-Motors without Rotation Sensors
+Motors without rotation sensors
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 .. _fig_pupdcmotors:
@@ -1,6 +1,6 @@
 .. pybricks-requirements::

-:mod:`pupdevices <pybricks.pupdevices>` -- Powered Up Devices
+:mod:`pupdevices <pybricks.pupdevices>` -- Powered Up devices
 =============================================================

 .. automodule:: pybricks.pupdevices
@@ -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
@@ -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.