This is the repository for the public SmartThings developer documentation.
This documentation is written using reStructuredText, powered by Sphinx, and hosted on ReadTheDocs.
Follow these steps to build the documentation locally:
- Install virtualenv.
- Create an isolated environment:
virtualenv --no-site-packages .venv - Activate the environment:
source .venv/bin/activate - Install dependencies:
(.venv)~/Documentation$ pip install -r requirements.txt - Build HTML:
(.venv)~/Documentation$ make html - Open
_build/html/index.htmlin a web browser.
To see the available make targets, simply execute make.
We love contributions! If you find a typo, error, or think something can be communicated better, fork this repository and make a pull request.
If you have a larger change that might involve a lot of new content or organization, let us know in advance by creating an issue.
For documentation formatting and syntax, please see the Writing the Docs Guide.
You can reach us at mailto:docs@smartthings.com with any feedback or questions.