Skip to content

Commit 2070c9d

Browse files
ikkezikkez
committed
update docs
1 parent af422c0 commit 2070c9d

File tree

8 files changed

+32
-33
lines changed

8 files changed

+32
-33
lines changed

‎anki_vector/behavior.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -213,21 +213,21 @@ def say_localized_text(self, text: str, use_vector_voice: bool = True, duration_
213213
with anki_vector.Robot() as robot:
214214
robot.behavior.say_localized_text("Hello World",language="de")
215215
216-
:param text: The words for Vector to say.
217-
:param use_vector_voice: Whether to use Vector's robot voice
218-
(otherwise, he uses a generic human male voice).
219-
:param duration_scalar: Adjust the relative duration of the
220-
generated text to speech audio.
221-
:param language: Adjust the language spoken for this text
222-
223-
possible values:
224-
de: German
225-
en: English
226-
ja or jp: Japanese
227-
fr: French
228-
229-
:return: object that provides the status and utterance state
230-
"""
216+
:param text: The words for Vector to say.
217+
:param use_vector_voice: Whether to use Vector's robot voice
218+
(otherwise, he uses a generic human male voice).
219+
:param duration_scalar: Adjust the relative duration of the
220+
generated text to speech audio.
221+
:param language: Adjust the language spoken for this text
222+
223+
possible values:
224+
- de: German
225+
- en: English
226+
- ja or jp: Japanese
227+
- fr: French
228+
229+
:return: object that provides the status and utterance state
230+
"""
231231

232232
if language == 'en':
233233
locale = 'en_US'

‎anki_vector/robot.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -806,11 +806,11 @@ async def get_latest_attention_transfer(self) -> protocol.LatestAttentionTransfe
806806
807807
.. testcode::
808808
809-
import anki_vector
810-
with anki_vector.Robot() as robot:
811-
att_trans = robot.get_latest_attention_transfer()
812-
if att_trans:
813-
print("Last attention transfer failed because of: {0}".format(att_trans.reason))
809+
import anki_vector
810+
with anki_vector.Robot() as robot:
811+
att_trans = robot.get_latest_attention_transfer()
812+
if att_trans:
813+
print("Last attention transfer failed because of: {0}".format(att_trans.reason))
814814
"""
815815
latest_attention_transfer = protocol.LatestAttentionTransferRequest()
816816
return await self.conn.grpc_interface.GetLatestAttentionTransfer(latest_attention_transfer)

‎docs/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,5 @@ The makefile can be used to build different documentation targets. The usual us
1919
the html version of the docs.
2020

2121
```bash
22-
make clean
23-
make html
22+
sphinx-build -b html source build
2423
```

‎docs/source/downloads.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ SDK Examples
88

99
Download Python example scripts that use the Vector SDK.
1010

11-
:verlink:`macOS/Linux SDK Examples <anki_vector_sdk_examples_0.0.0.tar.gz>`
11+
`macOS/Linux SDK Examples <https://sdk-resources.anki.com/vector/0.6.0/anki_vector_sdk_examples_0.6.0.tar.gz>`_
1212

13-
:verlink:`Windows SDK Examples <anki_vector_sdk_examples_0.0.0.zip>`
13+
`Windows SDK Examples <https://sdk-resources.anki.com/vector/0.6.0/anki_vector_sdk_examples_0.6.0.tar.gz>`_
1414

1515
------
1616
GitHub
1717
------
1818

19-
Clone, fork, or report issues on the `GitHub vector-python-sdk repository <https://github.com/anki/vector-python-sdk>`_.
19+
Clone, fork, or report issues on the `GitHub vector-python-sdk repository <https://github.com/ikkez/vector-python-sdk>`_.
2020

2121
----
2222

‎docs/source/initial.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ SDK Example Programs
2121

2222
Anki provides example programs for novice and advanced users to run with the SDK. Download the SDK example programs here:
2323

24-
* :verlink:`macOS/Linux SDK Examples <anki_vector_sdk_examples_0.0.0.tar.gz>`
24+
* `macOS/Linux SDK Examples <https://sdk-resources.anki.com/vector/0.6.0/anki_vector_sdk_examples_0.6.0.tar.gz>`_
2525

26-
* :verlink:`Windows SDK Examples <anki_vector_sdk_examples_0.0.0.zip>`
26+
* `Windows SDK Examples <https://sdk-resources.anki.com/vector/0.6.0/anki_vector_sdk_examples_0.6.0.tar.gz>`_
2727

2828
Once downloaded, extract the packaged files to a new directory.
2929

‎docs/source/install-linux.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ SDK Installation
5252

5353
To install the SDK, type the following into the Terminal window::
5454

55-
python3 -m pip install --user anki_vector
55+
python3 -m pip install --user ikkez_vector
5656

5757
"""""""""""
5858
SDK Upgrade
5959
"""""""""""
6060

6161
To upgrade the SDK from a previous install, enter this command::
6262

63-
python3 -m pip install --user --upgrade anki_vector
63+
python3 -m pip install --user --upgrade ikkez_vector
6464

6565
^^^^^^^^^^^^^^^^^^^^^
6666
Vector Authentication

‎docs/source/install-macos.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ SDK Installation
3939

4040
To install the SDK, type the following into the Terminal window::
4141

42-
python3 -m pip install --user anki_vector
42+
python3 -m pip install --user ikkez_vector
4343

4444
"""""""""""
4545
SDK Upgrade
4646
"""""""""""
4747

4848
To upgrade the SDK from a previous install, enter this command::
4949

50-
python3 -m pip install --user --upgrade anki_vector
50+
python3 -m pip install --user --upgrade ikkez_vector
5151

5252
^^^^^^^^^^^^^^^^^^^^^
5353
Vector Authentication

‎docs/source/install-windows.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ SDK Installation
3333

3434
To install the SDK, type the following into the Command Prompt window::
3535

36-
py -3 -m pip install --user anki_vector
36+
py -3 -m pip install --user ikkez_vector
3737

3838
.. note:: If you encounter an error during SDK installation, you may need to upgrade your pip install. Try ``python -m pip install --upgrade pip`` or ``py -3 -m pip install --upgrade pip``
3939

@@ -45,7 +45,7 @@ SDK Upgrade
4545

4646
To upgrade the SDK from a previous install, enter this command::
4747

48-
py -3 -m pip install --user --upgrade anki_vector
48+
py -3 -m pip install --user --upgrade ikkez_vector
4949

5050
^^^^^^^^^^^^^^^^^^^^^
5151
Vector Authentication

0 commit comments

Comments
 (0)