update docs

awslabs · Jun 5, 2024 · 912b6a6 · 912b6a6
1 parent 4a4fd22
commit 912b6a6
Show file tree

Hide file tree

Showing 47 changed files with 13,999 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: dd997feca9246d9432c476552bc17ff8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_sources/api/auth.rst.txt b/docs/_sources/api/auth.rst.txt
@@ -0,0 +1,6 @@
+awscrt.auth
+===========
+
+.. automodule:: awscrt.auth
+    :members:
+    :exclude-members: AwsCredentialsProviderBase
diff --git a/docs/_sources/api/common.rst.txt b/docs/_sources/api/common.rst.txt
@@ -0,0 +1,5 @@
+awscrt.common
+=============
+
+.. automodule:: awscrt.common
+    :members:
diff --git a/docs/_sources/api/crypto.rst.txt b/docs/_sources/api/crypto.rst.txt
@@ -0,0 +1,5 @@
+awscrt.crypto
+=============
+
+.. automodule:: awscrt.crypto
+    :members:
diff --git a/docs/_sources/api/eventstream.rst.txt b/docs/_sources/api/eventstream.rst.txt
@@ -0,0 +1,9 @@
+awscrt.eventstream
+==================
+
+.. automodule:: awscrt.eventstream
+    :members:
+
+.. automodule:: awscrt.eventstream.rpc
+    :members:
+
diff --git a/docs/_sources/api/exceptions.rst.txt b/docs/_sources/api/exceptions.rst.txt
@@ -0,0 +1,5 @@
+awscrt.exceptions
+=================
+
+.. automodule:: awscrt.exceptions
+    :members:
diff --git a/docs/_sources/api/http.rst.txt b/docs/_sources/api/http.rst.txt
@@ -0,0 +1,7 @@
+awscrt.http
+===========
+
+.. automodule:: awscrt.http
+    :members:
+    :inherited-members:
+    :exclude-members: HttpConnectionBase, HttpStreamBase, HttpMessageBase
diff --git a/docs/_sources/api/io.rst.txt b/docs/_sources/api/io.rst.txt
@@ -0,0 +1,5 @@
+awscrt.io
+=========
+
+.. automodule:: awscrt.io
+    :members:
diff --git a/docs/_sources/api/mqtt.rst.txt b/docs/_sources/api/mqtt.rst.txt
@@ -0,0 +1,6 @@
+awscrt.mqtt
+===========
+
+.. automodule:: awscrt.mqtt
+    :members:
+    :exclude-members: reconnect
diff --git a/docs/_sources/api/mqtt5.rst.txt b/docs/_sources/api/mqtt5.rst.txt
@@ -0,0 +1,5 @@
+awscrt.mqtt5
+============
+
+.. automodule:: awscrt.mqtt5
+    :members:
diff --git a/docs/_sources/api/s3.rst.txt b/docs/_sources/api/s3.rst.txt
@@ -0,0 +1,5 @@
+awscrt.s3
+=========
+
+.. automodule:: awscrt.s3
+    :members:
diff --git a/docs/_sources/api/websocket.rst.txt b/docs/_sources/api/websocket.rst.txt
@@ -0,0 +1,5 @@
+awscrt.websocket
+================
+
+.. automodule:: awscrt.websocket
+    :members:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,30 @@
+Welcome to awscrt's documentation!
+==================================
+Python bindings for the AWS Common Runtime.
+
+GitHub: https://github.com/awslabs/aws-crt-python
+
+PyPI: https://pypi.org/project/awscrt/
+
+API Reference
+-------------
+.. toctree::
+   :maxdepth: 2
+
+   api/auth
+   api/common
+   api/crypto
+   api/exceptions
+   api/eventstream
+   api/http
+   api/io
+   api/mqtt
+   api/mqtt5
+   api/s3
+   api/websocket
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/docs/_static/background_b01.png b/docs/_static/background_b01.png