`mqtt_connection_builder` appears in all of the examples, but appears to be undocumented

[justin8]

When searching through the repository and the API docs, I cannot find any mention of mqtt_connection_builder other than in the code examples and the __init__.py where it is imported from the CRT: https://github.com/aws/aws-iot-device-sdk-python-v2/blob/844bf38ebb13e316ea8100e364121e616c9e71df/awsiot/__init__.py#L12

The CRT API docs also don't list this awsiot_mqtt_connection_builder, although at least the code itself has a nice bit of documentation: https://github.com/awslabs/aws-crt-python/blob/main/awscrt/awsiot_mqtt_connection_builder.py

Since this appears to be essential to actually using the library, it would be great to have it mentioned in the docs outside of the example code.

[jmklix]

Thanks @justin8 for pointing this out. The docs are auto generated and should include this, so I will look into why this doesn't show up. Please let me know if anything regarding the mqtt_connection_builder that is still unclear after taking a look at https://github.com/awslabs/aws-crt-python/blob/main/awscrt/awsiot_mqtt_connection_builder.py?

[justin8]

I think it's clear from the docs in there, they seem fairly straightforward and well explained; it's just that I had to jump around a few projects to find them :)

[graebm]

https://github.com/aws/aws-iot-device-sdk-python-v2/pull/164

[graebm]

The docs are in: https://aws.github.io/aws-iot-device-sdk-python-v2/awsiot/mqtt_connection_builder.html

[github-actions[bot]]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.