Skip to content

Commit 7ae2782

Browse files
FThompsonAWSgraebm
andauthored
Python v2 device SDK docs (#98)
Add docs generation using Sphinx Co-authored-by: Michael Graeb <[email protected]>
1 parent 902f17f commit 7ae2782

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+22110
-1347
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ This document provides information about the AWS IoT device SDK for Python V2.
33

44
If you have any issues or feature requests, please file an issue or pull request.
55

6+
API documentation: https://awslabs.github.io/aws-iot-device-sdk-python-v2/
7+
68
This SDK is built on the AWS Common Runtime, a collection of libraries
79
([aws-c-common](https://github.com/awslabs/aws-c-common),
810
[aws-c-io](https://github.com/awslabs/aws-c-io),

awsiot/iotidentity.py

Lines changed: 163 additions & 223 deletions
Large diffs are not rendered by default.

awsiot/iotjobs.py

Lines changed: 381 additions & 487 deletions
Large diffs are not rendered by default.

awsiot/iotshadow.py

Lines changed: 489 additions & 637 deletions
Large diffs are not rendered by default.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
awsiot.greengrass_discovery
2+
===========================
3+
4+
.. automodule:: awsiot.greengrass_discovery
5+
:members:
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
awsiot.iotidentity
2+
==================
3+
4+
.. automodule:: awsiot.iotidentity
5+
:members:
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
awsiot.iotjobs
2+
==============
3+
4+
.. automodule:: awsiot.iotjobs
5+
:members:
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
awsiot.iotshadow
2+
================
3+
4+
.. automodule:: awsiot.iotshadow
5+
:members:

docs/_sources/index.rst.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. AWS IoT Device SDK Python v2 documentation master file, created by
2+
sphinx-quickstart on Mon Aug 17 14:57:36 2020.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
AWS IoT Device SDK Python v2
7+
============================
8+
9+
Python bindings for the AWS IoT Device API.
10+
11+
Developer Guide: https://docs.aws.amazon.com/iot/latest/developerguide
12+
13+
GitHub: https://github.com/aws/aws-iot-device-sdk-python-v2
14+
15+
PyPI: https://pypi.org/project/awsiotsdk/
16+
17+
API Reference
18+
-------------
19+
.. toctree::
20+
:maxdepth: 2
21+
22+
awsiot/greengrass_discovery
23+
awsiot/iotidentity
24+
awsiot/iotjobs
25+
awsiot/iotshadow
26+
27+
28+
29+
Indices and tables
30+
==================
31+
32+
* :ref:`genindex`
33+
* :ref:`modindex`
34+
* :ref:`search`

docs/_static/background_b01.png

78 Bytes
Loading

0 commit comments

Comments
 (0)