Merge pull request espressif#267 from gabsuren/esp_mqtt_cxx/updated_d…

…ocs_and_yml_file

docs(esp_mqtt_cxx): updated documentation and deployment *yml file

.github/workflows/publish-docs-component.yml

@@ -46,6 +46,6 @@ jobs:
       - name: Upload components to component service
         uses: espressif/github-actions/upload_components@master
         with:
-          directories: "components/esp_modem;components/esp_websocket_client;components/mdns;components/asio"
+          directories: "components/esp_modem;components/esp_websocket_client;components/mdns;components/asio;components/esp_mqtt_cxx"
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

README.md

@@ -22,3 +22,8 @@
 
 * Brief introduction [README](components/asio/README.md)
 * Full html [documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/asio/index.html)
+
+### esp_mqtt_cxx
+
+* Brief introduction [README](components/esp_mqtt_cxx/README.md)
+* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/esp_mqtt_cxx/index.html)

components/esp_mqtt_cxx/README.md

@@ -0,0 +1,13 @@
+# esp_mqtt_cxx
+
+[![Component Registry](https://components.espressif.com/components/espressif/esp_mqtt_cxx/badge.svg)](https://components.espressif.com/components/espressif/esp_mqtt_cxx)
+
+The ESP MQTT client is a wrapper over the esp_mqtt client with the goal of providing a higher level API.
+
+## Examples
+
+Get started with [examples](examples)
+
+## Documentation
+
+* View the full [html documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/esp_mqtt_cxx/index.html)

docs/esp_mqtt_cxx/en/index.rst

@@ -36,8 +36,8 @@ Events are dispatched throug calls to member functions each one dedicated to a t
 Application Example
 -------------------
 
-* :example:`tcp <../examples/tcp>`
-* :example:`ssl <../examples/ssl>`
+* :example:`tcp <../../components/esp_mqtt_cxx/examples/tcp>`
+* :example:`ssl <../../components/esp_mqtt_cxx/examples/ssl>`
 
 API Reference
 -------------