From 4bff13b5ca712cfd472cc44416070016bcacba2f Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Mon, 27 Jan 2020 13:03:41 +0100 Subject: [PATCH] doc: drop separate sound page The sound is not independently useable, and it is already documented for the speaker. --- doc/api/index.rst | 1 - doc/api/signaltypes.rst | 5 ++--- doc/api/sound.rst | 8 -------- 3 files changed, 2 insertions(+), 12 deletions(-) delete mode 100644 doc/api/sound.rst diff --git a/doc/api/index.rst b/doc/api/index.rst index 0da4808..706992a 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -38,4 +38,3 @@ Intro signaltypes frames motors - sound diff --git a/doc/api/signaltypes.rst b/doc/api/signaltypes.rst index 979ca43..f2d191c 100644 --- a/doc/api/signaltypes.rst +++ b/doc/api/signaltypes.rst @@ -138,7 +138,7 @@ Some signals do not have specific units. They range from a minimum (0%) to a maximum (100%). Specifics type of percentages are :ref:`relative distances ` or :ref:`brightness `. -Another example is the sound :meth:`volume <.builtins.Speaker.set_volume>`, +Another example is the sound volume, which ranges from 0% (silent) to 100% (loudest). .. _relativedistance: @@ -230,8 +230,7 @@ frequency: Hz -------------- Sound frequencies are expressed in Hertz (Hz). -For example, you can choose the frequency of a :meth:`beep -<.builtins.Speaker.beep>` to change the pitch. +For example, you can choose the frequency of a beep to change the pitch. .. _temperature: diff --git a/doc/api/sound.rst b/doc/api/sound.rst deleted file mode 100644 index 5af4cd5..0000000 --- a/doc/api/sound.rst +++ /dev/null @@ -1,8 +0,0 @@ -Making Sounds -============= - - -The Speaker Class -^^^^^^^^^^^^^^^^^ - -.. autoclass:: pybricks.builtins.Speaker