Home
elliottyates edited this page Jun 18, 2019
·
11 revisions
This will serve as a temporary home for sample code and documentation related to the SDK.
To install the latest version from master:
pip install git+ssh://git@github.com/penzance/canvas_python_sdk#egg=canvas-python-sdk
Sphinx should have been installed along with the SDK. If not, details instructions on how to install can be found here.
Note: If you get an error in the second step that says "UnicodeError: label empty or too long" try $ sphinx-apidoc -F -H -e -o docs .
$ cd canvas_python_sdk/canvas_sdk
$ sphinx-apidoc -F -e -o docs .
$ cd docs
Edit conf.py, find the line below:
#sys.path.insert(0, os.path.abspath("."))
and change it to:
sys.path.insert(0, os.path.abspath("../.."))
save and close the file
$ make html
Now you can open the file canvas_python_sdk/canvas_sdk/docs/_build/html/index.html in a browser. You may want to move the docs folder to another location or host it locally.