From d61fdb07c6278deba750f987b20441fff2df865f Mon Sep 17 00:00:00 2001 From: Grant Olson Date: Sun, 26 Apr 2020 17:28:48 -0400 Subject: [PATCH] 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