Add boto3sqs to docs

docs-requirements.txt

@@ -24,6 +24,7 @@ aiopg>=0.13.0,<1.3.0
 asyncpg>=0.12.0
 boto~=2.0
 botocore~=1.0
+boto3~=1.0
 celery>=4.0
 elasticsearch>=2.0,<9.0
 flask~=2.0

docs/conf.py

@@ -146,6 +146,16 @@ def getlistcfg(strval):
             )
         )
 
+if "obj" in mcfg:
+    objs = getlistcfg(mcfg["obj"])
+    for _obj in objs:
+        nitpick_ignore.append(
+            (
+                "py:obj",
+                _obj,
+            )
+        )
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

docs/instrumentation/boto3sqs/boto3sqs.rst

@@ -0,0 +1,6 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-boto3sqs/README.rst
+
+.. automodule:: opentelemetry.instrumentation.boto3sqs
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/nitpick-exceptions.ini

@@ -44,3 +44,6 @@ anys=
     ; - instrumentation.*
     Setter
     httpx
+
+obj=
+    opentelemetry.propagators.textmap.CarrierT

instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py

@@ -12,21 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """
-Instrument `boto3sqs`_ to trace SQS applications.
+Instrument boto3sqs to trace SQS applications.
 
 .. _boto3sqs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html
 
-
 Usage
 -----
 
-.. code:: python
+.. code-block:: python
 
     import boto3
     from opentelemetry.instrumentation.boto3sqs import Boto3SQSInstrumentor
 
-
     Boto3SQSInstrumentor().instrument()
+
+---
 """
 import logging
 from typing import Any, Collection, Dict, Generator, List, Mapping, Optional
@@ -102,9 +102,9 @@ class ContextableList(list):
         """
         Since the classic way to process SQS messages is using a `for` loop, without a well defined scope like a
         callback - we are doing something similar to the instrumentaiton of Kafka-python and instrumenting the
-        `__iter__` functions and the `__getitem__` functions to set the span context of the addressed message. Since
-        the return value from an `SQS.ReceiveMessage` returns a builtin list, we cannot wrap it and change all of the
-        calls for `list.__iter__` and `list.__getitem__` - therefore we use ContextableList. It is bound to the
+        '__iter__' functions and the '__getitem__' functions to set the span context of the addressed message. Since
+        the return value from an 'SQS.ReceiveMessage' returns a builtin list, we cannot wrap it and change all of the
+        calls for 'list.__iter__' and 'list.__getitem__' - therefore we use ContextableList. It is bound to the
         received_messages_spans dict
         """