SmartThings Documentation
Clone or download
erodewald and jimmyjames Fix selector style that displaced links when trying to click them (#659)
Remove border-top from rst-versions

Remove markup in versions template

Revert removal of rst-versions

Remove include versions

Upgrad sphinx

Revert remove include versions

Tweak versions

Change theme name back to sphinx_rtd_theme


Revert version sphinx to 1.4


Revert versions.html
Latest commit 90e82dd Nov 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Add redirect notice banner (#657) Oct 31, 2018
_static Fix selector style that displaced links when trying to click them (#659) Nov 1, 2018
_templates add custom theme template (#638) Oct 12, 2017
_theme/sphinx_rtd_theme Fix selector style that displaced links when trying to click them (#659) Nov 1, 2018
architecture [DOCS-463] Revised docs to update glossary terms (#597) Mar 14, 2017
arduino [DOCS-463] Revised docs to update glossary terms (#597) Mar 14, 2017
cloud-and-lan-connected-device-types-developers-guide [DOCS-440] - document capturing and displaying images from cameras. (#… Apr 17, 2017
common fix more build warnings Nov 15, 2016
composite-devices [DOCS-469] Composite tiles document (#605) May 4, 2017
contributing glossary of ST terms (#596) Mar 14, 2017
device-type-developers-guide Fix minor typo in z-wave documentation (#622) Jun 14, 2017
getting-started Edited the Account creation URL Apr 5, 2018
img [DOCS-469] Composite tiles document (#605) May 4, 2017
publishing [DOCS-460] update publication for public distribution docs (#592) Mar 8, 2017
ratelimits [DOCS-468] document child install limits (#604) Apr 20, 2017
readthedocs/settings try adding local settings (#639) Oct 12, 2017
ref-docs Disclaimer in the schedule docs to avoid private scoped methods and p… Sep 8, 2018
smartapp-developers-guide Update devices.rst (#630) Jul 31, 2017
smartapp-web-services-developers-guide target master for small typo fix in #635 (#636) Aug 14, 2017
tools-and-ide [DOCS-463] Revised docs to update glossary terms (#597) Mar 14, 2017
.gitignore [DOCS-463] Revised docs to update glossary terms (#597) Mar 14, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Apr 6, 2016
Makefile remove legacy capabilities docs generation (#644) Jan 20, 2018
README.md Add getLastActivityDate and getStatus to Device (#549) Jan 31, 2017
capabilities-reference.rst [DOCS-517] put back some basic capabilities docs in legacy site (#649) May 8, 2018
code-review-guidelines.rst [DOCS-463] Revised docs to update glossary terms (#597) Mar 14, 2017
conf.py Fix selector style that displaced links when trying to click them (#659) Nov 1, 2018
index.rst Add redirect notice banner (#657) Oct 31, 2018
latest-updates.rst release notes for July 07 2017 docs release (#626) Jul 7, 2017
requirements.txt Add redirect notice banner (#657) Oct 31, 2018
sept-2015-faq.rst [DOCS-463] Revised docs to update glossary terms (#597) Mar 14, 2017

README.md

SmartThings Developer Documentation

This is the repository for the public SmartThings developer documentation.

This documentation is written using reStructuredText, powered by Sphinx, and hosted on ReadTheDocs.

Building the docs

Follow these steps to build the documentation locally:

  1. Install virtualenv.
  2. Create an isolated environment in a different location than the Documentation directory: virtualenv --no-site-packages .venv
  3. Activate the environment: source .venv/bin/activate
  4. Install dependencies: (.venv)~/Documentation$ pip install -r requirements.txt
  5. Build HTML: (.venv)~/Documentation$ make html
  6. Open _build/html/index.html in a web browser.

To see the available make targets, simply execute make.

Contributing

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.

Style guide

For documentation formatting and syntax, please see the Writing the Docs Guide.

Pull request guidelines

We use the fork-and-pull GitHub flow. You should fork this repository, configure a remote for your fork, and keep your fork in sync. This is all documented in the Working with forks GitHub documentation.

Once your fork is configured and synced with the latest, you should make your changes on a topic branch, commit those changes, and push the branch to make a Pull Request:

  1. Checkout a topic branch based off your master branch (this should be synced with the SmartThingsCommunity/Documentation repository):

    $ git checkout -b topic-branch-name origin/master

    Where "topic-branch-name" is descriptive of your changes (for example, "fix-scheduling-broken-link").

  2. Once you are confident in your changes, you can add them to your index and commit them. Be sure to include a meaningful commit message. Each PR should have exactly one commit. If you have multiple commits on your branch, squash them before making the PR.

    NOTE: SmartThings employees should include the JIRA ticket number at the beginning of the commit message (e.g., "[DOCS-234] add documentation for passing data to scheduler method callbacks").

  3. Push your topic branch to your fork's remote:

    $ git push origin topic-branch-name

  4. Visit your fork's remote in a web browser. There will be a yellow banner indicating new changes have been pushed, with the option to make a pull request from them. Click that link.

  5. On the Pull Request page, verify your changes look correct, add any description necessary, and submit the pull request. The documentation team will always review any pull requests, but if anything requires the attention of someone specific, @ them in the pull request description.

  6. If there are changes requested as part of the pull request review, you can either add new commits to the PR, or amend your existing commit. If you add new commits, be sure to squash them to one commit before merging.

  7. Once the PR has a +1 (thumbs-up emoji), a member of the docs team will merge your PR.

Contact

You can reach us at mailto:docs@smartthings.com with any feedback or questions.