Skip to content

Commit

Permalink
documentation: add readthedocs link to README (#142)
Browse files Browse the repository at this point in the history
  • Loading branch information
@avawang1
avawang1 authored Aug 14, 2020
1 parent b2206b8 commit 488607a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ Coming soon

## Braket Python SDK API Reference Documentation

The API reference, can be found on [Read the Docs](https://amazon-braket-sdk-python.readthedocs.io/en/latest/).

**To generate the API Reference HTML in your local environment**

To generate the HTML, first change directories (`cd`) to position the cursor in the `amazon-braket-sdk-python` directory. Then, run the following command to generate the HTML documentation files:
Expand Down

0 comments on commit 488607a

Please sign in to comment.