Update readme and example

PierreF commented 5 months ago

This update the README and examples:

To fix breaking change in example present inside the READ
To fix breaking change in examples directory
It drop duplicate documentation in README that is also present as docstring. Have duplicated documentation is too much work with no gain. I want to kept README being a guide / example of usage. And docstring is the reference of all functions with all arguments.

I've added Sphinx documentation (only expose docstring for now). There is a markdown export to serve them from the Github repository, but that more a workaround because finding a right place to host the documentation (readthedocs ?)

PierreF commented 5 months ago

The PR is based of #808 for conflict but also because I spotted those private objects while checking the documentation output.

PierreF commented 5 months ago

The documentation is now available online at https://eclipse.dev/paho/files/paho.mqtt.python/html/index.html

eclipse / paho.mqtt.python

Update readme and example #804