From 400067c364c75be78d0375ae3447e2dc446196eb Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Tue, 12 Jan 2021 16:50:18 +0100 Subject: [PATCH] doc/hubs/ev3brick: use footnote instead of toggle This is a way to make the language list non-distracting without the contentui plugin --- doc/api/hubs/ev3brick.rst | 190 +++++++++++++++++++------------------- pybricks/_common.py | 7 +- 2 files changed, 97 insertions(+), 100 deletions(-) diff --git a/doc/api/hubs/ev3brick.rst b/doc/api/hubs/ev3brick.rst index 44c1873..05a9fce 100644 --- a/doc/api/hubs/ev3brick.rst +++ b/doc/api/hubs/ev3brick.rst @@ -29,104 +29,8 @@ MINDSTORMS EV3 Brick .. automethod:: pybricks.hubs::EV3Brick.speaker.set_speech_options - .. toggle-header:: - :header: **Show/hide available languages and voices** - - You can choose the following languages: - - - ``'af'``: Afrikaans - - ``'an'``: Aragonese - - ``'bg'``: Bulgarian - - ``'bs'``: Bosnian - - ``'ca'``: Catalan - - ``'cs'``: Czech - - ``'cy'``: Welsh - - ``'da'``: Danish - - ``'de'``: German - - ``'el'``: Greek - - ``'en'``: English (default) - - ``'en-gb'``: English (United Kingdom) - - ``'en-sc'``: English (Scotland) - - ``'en-uk-north'``: English (United Kingdom, Northern) - - ``'en-uk-rp'``: - English (United Kingdom, Received Pronunciation) - - ``'en-uk-wmids'``: English (United Kingdom, West Midlands) - - ``'en-us'``: English (United States) - - ``'en-wi'``: English (West Indies) - - ``'eo'``: Esperanto - - ``'es'``: Spanish - - ``'es-la'``: Spanish (Latin America) - - ``'et'``: Estonian - - ``'fa'``: Persian - - ``'fa-pin'``: Persian - - ``'fi'``: Finnish - - ``'fr-be'``: French (Belgium) - - ``'fr-fr'``: French (France) - - ``'ga'``: Irish - - ``'grc'``: Greek - - ``'hi'``: Hindi - - ``'hr'``: Croatian - - ``'hu'``: Hungarian - - ``'hy'``: Armenian - - ``'hy-west'``: Armenian (Western) - - ``'id'``: Indonesian - - ``'is'``: Icelandic - - ``'it'``: Italian - - ``'jbo'``: Lojban - - ``'ka'``: Georgian - - ``'kn'``: Kannada - - ``'ku'``: Kurdish - - ``'la'``: Latin - - ``'lfn'``: Lingua Franca Nova - - ``'lt'``: Lithuanian - - ``'lv'``: Latvian - - ``'mk'``: Macedonian - - ``'ml'``: Malayalam - - ``'ms'``: Malay - - ``'ne'``: Nepali - - ``'nl'``: Dutch - - ``'no'``: Norwegian - - ``'pa'``: Punjabi - - ``'pl'``: Polish - - ``'pt-br'``: Portuguese (Brazil) - - ``'pt-pt'``: Portuguese (Portugal) - - ``'ro'``: Romanian - - ``'ru'``: Russian - - ``'sk'``: Slovak - - ``'sq'``: Albanian - - ``'sr'``: Serbian - - ``'sv'``: Swedish - - ``'sw'``: Swahili - - ``'ta'``: Tamil - - ``'tr'``: Turkish - - ``'vi'``: Vietnamese - - ``'vi-hue'``: Vietnamese (Hue) - - ``'vi-sgn'``: Vietnamese (Saigon) - - ``'zh'``: Mandarin Chinese - - ``'zh-yue'``: Cantonese Chinese - - You can choose the following voices: - - - ``'f1'``: female variant 1 - - ``'f2'``: female variant 2 - - ``'f3'``: female variant 3 - - ``'f4'``: female variant 4 - - ``'f5'``: female variant 5 - - ``'m1'``: male variant 1 - - ``'m2'``: male variant 2 - - ``'m3'``: male variant 3 - - ``'m4'``: male variant 4 - - ``'m5'``: male variant 5 - - ``'m6'``: male variant 6 - - ``'m7'``: male variant 7 - - ``'croak'``: croak - - ``'whisper'``: whisper - - ``'whisperf'``: female whisper - - .. automethod:: pybricks.hubs::EV3Brick.speaker.set_volume - .. rubric:: Using the screen .. |this image| replace:: the screen @@ -200,3 +104,97 @@ Using different fonts .. raw:: latex \end{CJK} + +.. rubric:: Available languages and voices for speech + +.. [#espeak_lang] + + You can choose the following languages: + + - ``'af'``: Afrikaans + - ``'an'``: Aragonese + - ``'bg'``: Bulgarian + - ``'bs'``: Bosnian + - ``'ca'``: Catalan + - ``'cs'``: Czech + - ``'cy'``: Welsh + - ``'da'``: Danish + - ``'de'``: German + - ``'el'``: Greek + - ``'en'``: English (default) + - ``'en-gb'``: English (United Kingdom) + - ``'en-sc'``: English (Scotland) + - ``'en-uk-north'``: English (United Kingdom, Northern) + - ``'en-uk-rp'``: English (United Kingdom, Received Pronunciation) + - ``'en-uk-wmids'``: English (United Kingdom, West Midlands) + - ``'en-us'``: English (United States) + - ``'en-wi'``: English (West Indies) + - ``'eo'``: Esperanto + - ``'es'``: Spanish + - ``'es-la'``: Spanish (Latin America) + - ``'et'``: Estonian + - ``'fa'``: Persian + - ``'fa-pin'``: Persian + - ``'fi'``: Finnish + - ``'fr-be'``: French (Belgium) + - ``'fr-fr'``: French (France) + - ``'ga'``: Irish + - ``'grc'``: Greek + - ``'hi'``: Hindi + - ``'hr'``: Croatian + - ``'hu'``: Hungarian + - ``'hy'``: Armenian + - ``'hy-west'``: Armenian (Western) + - ``'id'``: Indonesian + - ``'is'``: Icelandic + - ``'it'``: Italian + - ``'jbo'``: Lojban + - ``'ka'``: Georgian + - ``'kn'``: Kannada + - ``'ku'``: Kurdish + - ``'la'``: Latin + - ``'lfn'``: Lingua Franca Nova + - ``'lt'``: Lithuanian + - ``'lv'``: Latvian + - ``'mk'``: Macedonian + - ``'ml'``: Malayalam + - ``'ms'``: Malay + - ``'ne'``: Nepali + - ``'nl'``: Dutch + - ``'no'``: Norwegian + - ``'pa'``: Punjabi + - ``'pl'``: Polish + - ``'pt-br'``: Portuguese (Brazil) + - ``'pt-pt'``: Portuguese (Portugal) + - ``'ro'``: Romanian + - ``'ru'``: Russian + - ``'sk'``: Slovak + - ``'sq'``: Albanian + - ``'sr'``: Serbian + - ``'sv'``: Swedish + - ``'sw'``: Swahili + - ``'ta'``: Tamil + - ``'tr'``: Turkish + - ``'vi'``: Vietnamese + - ``'vi-hue'``: Vietnamese (Hue) + - ``'vi-sgn'``: Vietnamese (Saigon) + - ``'zh'``: Mandarin Chinese + - ``'zh-yue'``: Cantonese Chinese + + You can choose the following voices: + + - ``'f1'``: female variant 1 + - ``'f2'``: female variant 2 + - ``'f3'``: female variant 3 + - ``'f4'``: female variant 4 + - ``'f5'``: female variant 5 + - ``'m1'``: male variant 1 + - ``'m2'``: male variant 2 + - ``'m3'``: male variant 3 + - ``'m4'``: male variant 4 + - ``'m5'``: male variant 5 + - ``'m6'``: male variant 6 + - ``'m7'``: male variant 7 + - ``'croak'``: croak + - ``'whisper'``: whisper + - ``'whisperf'``: female whisper diff --git a/pybricks/_common.py b/pybricks/_common.py index b499023..fa77e02 100644 --- a/pybricks/_common.py +++ b/pybricks/_common.py @@ -380,12 +380,11 @@ class Speaker: Arguments: language (str): Language of the text. For example, you can choose ``'en'`` - (English) or ``'de'`` (German). A list of all available - languages is given below. + (English) or ``'de'`` (German). [#espeak_lang]_ voice (str): The voice to use. For example, you can choose ``'f1'`` (female - voice variant 1) or ``'m3'`` (male voice variant 3). A list of - all available voices is given below. + voice variant 1) or ``'m3'`` (male voice variant 3). + [#espeak_lang]_ speed (int): Number of words per minute. pitch (int):