Python v2 device SDK docs #98
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
TingDaoK
reviewed
Sep 1, 2020
Contributor
TingDaoK
left a comment
TingDaoK
left a comment
There was a problem hiding this comment.
Thank you for the PR. Only thing I want to bring up is how should we link from the doc for aws-iot-device-sdk-python-v2 to the doc of aws-crt-python. So, lots of the APIs used here is based on aws-crt-python. We will need a proper way to reference to the doc of aws-crt-python to make it more clear.
graebm
reviewed
Sep 3, 2020
FThompsonAWS
force-pushed
the
docs
branch
3 times, most recently
from
1d06009 to
c184ce9
Compare
- replace doc makefile with python script - run `python3 make-docs.py` to regenerate docs
graebm
approved these changes
Sep 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available: N/A
Description of changes:
This PR adds doc generation using Sphinx and updates existing docstrings to use a formatted supported by Sphinx.
The doc output can be hosted on GitHub Pages with /docs/html as the root, for example.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.