From c94d2f4cf99e2fd963a30b0939fc306a28057e16 Mon Sep 17 00:00:00 2001 From: Michelle Sintov Date: Tue, 30 Apr 2019 22:26:31 -0700 Subject: [PATCH 1/4] Release 0.6.0 patch #21 Add comment describing where wav files can be found to tutorial --- examples/tutorials/10_play_audio.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/examples/tutorials/10_play_audio.py b/examples/tutorials/10_play_audio.py index 5076155..499989f 100755 --- a/examples/tutorials/10_play_audio.py +++ b/examples/tutorials/10_play_audio.py @@ -23,8 +23,13 @@ def main(): args = anki_vector.util.parse_command_args() with anki_vector.Robot(args.serial) as robot: - robot.audio.stream_wav_file("../sounds/vector_bell_whistle.wav", 75) - robot.audio.stream_wav_file("../sounds/vector_alert.wav", 75) + # You can find these sounds files here: + # https://github.com/anki/vector-python-sdk/blob/master/examples/sounds/vector_alert.wav + # https://github.com/anki/vector-python-sdk/blob/master/examples/sounds/vector_bell_whistle.wav + # + # Paste these two wav files next to this tutorial to play sounds. + robot.audio.stream_wav_file("vector_bell_whistle.wav", 75) + robot.audio.stream_wav_file("vector_alert.wav", 75) if __name__ == "__main__": From e16c50404289be0d0b483a06f6f2f74755f48728 Mon Sep 17 00:00:00 2001 From: Michelle Sintov Date: Tue, 30 Apr 2019 22:42:05 -0700 Subject: [PATCH 2/4] Release 0.6.0 --- anki_vector/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/anki_vector/version.py b/anki_vector/version.py index 829dce5..252ecf8 100644 --- a/anki_vector/version.py +++ b/anki_vector/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "0.5.2.dev0" +__version__ = "0.6.1.dev0" From 766e0e160cd4f1d02ef2497c0e0de1516fdaa086 Mon Sep 17 00:00:00 2001 From: jejacks0n Date: Thu, 2 May 2019 16:25:33 -0600 Subject: [PATCH 3/4] Updates links in README. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4c37c1a..6e1e432 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,18 @@ ![Vector](docs/source/images/vector-sdk-alpha.jpg) -Learn more about Vector: https://www.anki.com/vector +Learn more about Vector: https://www.anki.com/en-us/vector Learn more about the SDK: https://developer.anki.com/ -SDK documentation: http://developer.anki.com/vector/docs/ +SDK documentation: https://developer.anki.com/vector/docs/index.html Forums: https://forums.anki.com/ ## Getting Started -You can follow steps [here](http://developer.anki.com/vector/docs/) to set up your Vector robot with the SDK. +You can follow steps [here](https://developer.anki.com/vector/docs/index.html) to set up your Vector robot with the SDK. ## Privacy Policy and Terms and Conditions From d61fdb07c6278deba750f987b20441fff2df865f Mon Sep 17 00:00:00 2001 From: Grant Olson Date: Sun, 26 Apr 2020 17:28:48 -0400 Subject: [PATCH 4/4] Tell SDK users how to build a copy of the documentation that can be accessed even if Anki servers go away --- README.md | 3 +++ docs/README.md | 11 +++++++++++ docs/requirements.txt | 3 +++ 3 files changed, 17 insertions(+) create mode 100644 docs/requirements.txt diff --git a/README.md b/README.md index 6e1e432..5caa72d 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ Forums: https://forums.anki.com/ You can follow steps [here](https://developer.anki.com/vector/docs/index.html) to set up your Vector robot with the SDK. +You can also generate a local copy of the SDK documetation by +following the instructions in the `docs` folder of this project. + ## Privacy Policy and Terms and Conditions diff --git a/docs/README.md b/docs/README.md index 457b3b0..2bfb8cf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,6 +7,14 @@ so changes to the source code will be reflected in docs builds. To update and build the docs, follow the steps below. +## Installing sphinx + +The +[Sphinx Documetation Generator](https://www.sphinx-doc.org/en/master/) +is used to build the docs. You'll need to have it installed on your +system with `pip install -r requirements.txt` using the +`requirements.txt` file in this directory and not the main project directory. + ## Updating the Docs There are a few files that are not automatically generated and reside in `source`. For example, @@ -22,3 +30,6 @@ the html version of the docs. make clean make html ``` + +You will now have an offline copy of the documetation that can be +accessed by opening `.build/html/index.html` diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..51674ac --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinx-autodoc-typehints +sphinx_rtd_theme