From ab6b15f0477e1c08a13e219b18babfca4cd08ce0 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Wed, 29 Jan 2020 14:47:03 +0100 Subject: [PATCH] doc/media: toggle items by category Make it easier to browse the options. --- doc/api/media.rst | 195 +++++++++++++++++++++++++++++++++++++++ pybricks/media/ev3dev.py | 189 +------------------------------------ 2 files changed, 197 insertions(+), 187 deletions(-) diff --git a/doc/api/media.rst b/doc/api/media.rst index 8e9d00d..192b6c4 100644 --- a/doc/api/media.rst +++ b/doc/api/media.rst @@ -20,12 +20,207 @@ Images .. autoclass:: pybricks.media.ev3dev.ImageFile :no-members: + .. toggle-header:: + :header: **Information** + + .. data:: RIGHT + .. data:: FORWARD + .. data:: ACCEPT + .. data:: QUESTION_MARK + .. data:: STOP_1 + .. data:: LEFT + .. data:: DECLINE + .. data:: THUMBS_DOWN + .. data:: BACKWARD + .. data:: NO_GO + .. data:: WARNING + .. data:: STOP_2 + .. data:: THUMBS_UP + + .. toggle-header:: + :header: **LEGO** + + .. data:: EV3 + .. data:: EV3_ICON + + .. toggle-header:: + :header: **Objects** + + .. data:: TARGET + + .. toggle-header:: + :header: **Eyes** + + .. data:: BOTTOM_RIGHT + .. data:: BOTTOM_LEFT + .. data:: EVIL + .. data:: CRAZY_2 + .. data:: KNOCKED_OUT + .. data:: PINCHED_RIGHT + .. data:: WINKING + .. data:: DIZZY + .. data:: DOWN + .. data:: TIRED_MIDDLE + .. data:: MIDDLE_RIGHT + .. data:: SLEEPING + .. data:: MIDDLE_LEFT + .. data:: TIRED_RIGHT + .. data:: PINCHED_LEFT + .. data:: PINCHED_MIDDLE + .. data:: CRAZY_1 + .. data:: NEUTRAL + .. data:: AWAKE + .. data:: UP + .. data:: TIRED_LEFT + .. data:: ANGRY + Sounds ^^^^^^ .. autoclass:: pybricks.media.ev3dev.SoundFile :no-members: + .. toggle-header:: + :header: **Expressions** + + .. data:: SHOUTING + .. data:: CHEERING + .. data:: CRYING + .. data:: OUCH + .. data:: LAUGHING_2 + .. data:: SNEEZING + .. data:: SMACK + .. data:: BOING + .. data:: BOO + .. data:: UH_OH + .. data:: SNORING + .. data:: KUNG_FU + .. data:: FANFARE + .. data:: CRUNCHING + .. data:: MAGIC_WAND + .. data:: LAUGHING_1 + + .. toggle-header:: + :header: **Information** + + .. data:: LEFT + .. data:: BACKWARDS + .. data:: RIGHT + .. data:: OBJECT + .. data:: COLOR + .. data:: FLASHING + .. data:: ERROR + .. data:: ERROR_ALARM + .. data:: DOWN + .. data:: FORWARD + .. data:: ACTIVATE + .. data:: SEARCHING + .. data:: TOUCH + .. data:: UP + .. data:: ANALYZE + .. data:: STOP + .. data:: DETECTED + .. data:: TURN + .. data:: START + + .. toggle-header:: + :header: **Communication** + + .. data:: MORNING + .. data:: EV3 + .. data:: GO + .. data:: GOOD_JOB + .. data:: OKEY_DOKEY + .. data:: GOOD + .. data:: NO + .. data:: THANK_YOU + .. data:: YES + .. data:: GAME_OVER + .. data:: OKAY + .. data:: SORRY + .. data:: BRAVO + .. data:: GOODBYE + .. data:: HI + .. data:: HELLO + .. data:: MINDSTORMS + .. data:: LEGO + .. data:: FANTASTIC + + .. toggle-header:: + :header: **Movement sounds** + + .. data:: SPEED_IDLE + .. data:: SPEED_DOWN + .. data:: SPEED_UP + + .. toggle-header:: + :header: **Colors** + + .. data:: BROWN + .. data:: GREEN + .. data:: BLACK + .. data:: WHITE + .. data:: RED + .. data:: BLUE + .. data:: YELLOW + + .. toggle-header:: + :header: **Mechanical** + + .. data:: TICK_TACK + .. data:: HORN_1 + .. data:: BACKING_ALERT + .. data:: MOTOR_IDLE + .. data:: AIR_RELEASE + .. data:: AIRBRAKE + .. data:: RATCHET + .. data:: MOTOR_STOP + .. data:: HORN_2 + .. data:: LASER + .. data:: SONAR + .. data:: MOTOR_START + + .. toggle-header:: + :header: **Animal sounds** + + .. data:: INSECT_BUZZ_2 + .. data:: ELEPHANT_CALL + .. data:: SNAKE_HISS + .. data:: DOG_BARK_2 + .. data:: DOG_WHINE + .. data:: INSECT_BUZZ_1 + .. data:: DOG_SNIFF + .. data:: T_REX_ROAR + .. data:: INSECT_CHIRP + .. data:: DOG_GROWL + .. data:: SNAKE_RATTLE + .. data:: DOG_BARK_1 + .. data:: CAT_PURR + + .. toggle-header:: + :header: **Numbers** + + .. data:: ZERO + .. data:: ONE + .. data:: TWO + .. data:: THREE + .. data:: FOUR + .. data:: FIVE + .. data:: SIX + .. data:: SEVEN + .. data:: EIGHT + .. data:: NINE + .. data:: TEN + + .. toggle-header:: + :header: **System sounds** + + .. data:: READY + .. data:: CONFIRM + .. data:: GENERAL_ALERT + .. data:: CLICK + .. data:: OVERPOWER + Fonts ^^^^^ diff --git a/pybricks/media/ev3dev.py b/pybricks/media/ev3dev.py index fc4c183..8c684d3 100644 --- a/pybricks/media/ev3dev.py +++ b/pybricks/media/ev3dev.py @@ -258,141 +258,7 @@ Font.DEFAULT = Font('Lucida', 12) class SoundFile(): - """Paths to standard EV3 sounds. - - Expressions - - .. data:: SHOUTING - .. data:: CHEERING - .. data:: CRYING - .. data:: OUCH - .. data:: LAUGHING_2 - .. data:: SNEEZING - .. data:: SMACK - .. data:: BOING - .. data:: BOO - .. data:: UH_OH - .. data:: SNORING - .. data:: KUNG_FU - .. data:: FANFARE - .. data:: CRUNCHING - .. data:: MAGIC_WAND - .. data:: LAUGHING_1 - - Information - - .. data:: LEFT - .. data:: BACKWARDS - .. data:: RIGHT - .. data:: OBJECT - .. data:: COLOR - .. data:: FLASHING - .. data:: ERROR - .. data:: ERROR_ALARM - .. data:: DOWN - .. data:: FORWARD - .. data:: ACTIVATE - .. data:: SEARCHING - .. data:: TOUCH - .. data:: UP - .. data:: ANALYZE - .. data:: STOP - .. data:: DETECTED - .. data:: TURN - .. data:: START - - Communication - - .. data:: MORNING - .. data:: EV3 - .. data:: GO - .. data:: GOOD_JOB - .. data:: OKEY_DOKEY - .. data:: GOOD - .. data:: NO - .. data:: THANK_YOU - .. data:: YES - .. data:: GAME_OVER - .. data:: OKAY - .. data:: SORRY - .. data:: BRAVO - .. data:: GOODBYE - .. data:: HI - .. data:: HELLO - .. data:: MINDSTORMS - .. data:: LEGO - .. data:: FANTASTIC - - Movements - - .. data:: SPEED_IDLE - .. data:: SPEED_DOWN - .. data:: SPEED_UP - - Color - - .. data:: BROWN - .. data:: GREEN - .. data:: BLACK - .. data:: WHITE - .. data:: RED - .. data:: BLUE - .. data:: YELLOW - - Mechanical - - .. data:: TICK_TACK - .. data:: HORN_1 - .. data:: BACKING_ALERT - .. data:: MOTOR_IDLE - .. data:: AIR_RELEASE - .. data:: AIRBRAKE - .. data:: RATCHET - .. data:: MOTOR_STOP - .. data:: HORN_2 - .. data:: LASER - .. data:: SONAR - .. data:: MOTOR_START - - Animals - - .. data:: INSECT_BUZZ_2 - .. data:: ELEPHANT_CALL - .. data:: SNAKE_HISS - .. data:: DOG_BARK_2 - .. data:: DOG_WHINE - .. data:: INSECT_BUZZ_1 - .. data:: DOG_SNIFF - .. data:: T_REX_ROAR - .. data:: INSECT_CHIRP - .. data:: DOG_GROWL - .. data:: SNAKE_RATTLE - .. data:: DOG_BARK_1 - .. data:: CAT_PURR - - Numbers - - .. data:: ZERO - .. data:: ONE - .. data:: TWO - .. data:: THREE - .. data:: FOUR - .. data:: FIVE - .. data:: SIX - .. data:: SEVEN - .. data:: EIGHT - .. data:: NINE - .. data:: TEN - - System - - .. data:: READY - .. data:: CONFIRM - .. data:: GENERAL_ALERT - .. data:: CLICK - .. data:: OVERPOWER - - """ + """Paths to standard EV3 sounds.""" _BASE_PATH = '/usr/share/sounds/ev3dev/' SHOUTING = _BASE_PATH + 'expressions/shouting.wav' @@ -503,58 +369,7 @@ class SoundFile(): class ImageFile(): - """Paths to standard EV3 images. - - Information - - .. data:: RIGHT - .. data:: FORWARD - .. data:: ACCEPT - .. data:: QUESTION_MARK - .. data:: STOP_1 - .. data:: LEFT - .. data:: DECLINE - .. data:: THUMBS_DOWN - .. data:: BACKWARD - .. data:: NO_GO - .. data:: WARNING - .. data:: STOP_2 - .. data:: THUMBS_UP - - LEGO - - .. data:: EV3 - .. data:: EV3_ICON - - Objects - - .. data:: TARGET - - Eyes - - .. data:: BOTTOM_RIGHT - .. data:: BOTTOM_LEFT - .. data:: EVIL - .. data:: CRAZY_2 - .. data:: KNOCKED_OUT - .. data:: PINCHED_RIGHT - .. data:: WINKING - .. data:: DIZZY - .. data:: DOWN - .. data:: TIRED_MIDDLE - .. data:: MIDDLE_RIGHT - .. data:: SLEEPING - .. data:: MIDDLE_LEFT - .. data:: TIRED_RIGHT - .. data:: PINCHED_LEFT - .. data:: PINCHED_MIDDLE - .. data:: CRAZY_1 - .. data:: NEUTRAL - .. data:: AWAKE - .. data:: UP - .. data:: TIRED_LEFT - .. data:: ANGRY - """ + """Paths to standard EV3 images.""" _BASE_PATH = '/usr/share/images/ev3dev/mono/' RIGHT = _BASE_PATH + 'information/right.png'