Inconsistent documentation

[dannystaple]

trafficstars

Prerequisites

A small team of volunteers monitors issues. Please help us to help you by making it simple to understand and, if possible, replicate your issue. Prior to reporting a bug please:

• [ ] Test the latest release of the library.
• [x] Search existing issues.
• [x] Read the relevant documentation.
• [ ] Review your server configuration and logs.
• [ ] Consider testing against a different server (e.g. mqtt.eclipseprojects.io or test.mosquitto.org)
• [ ] If possible, test using another tool (e.g. MQTTX / mosquitto_sub) to confirm the issue is specific to this client.
• [ ] If you are unsure if you have found a bug, please consider asking on stackoverflow for a quicker response.

Bug Description

The documentation for Python Paho is not consistent, nor is it clear what is the canonical documentation.

• There seems to be documentation in a readme.RST at the top of this repo.
• the documentation at https://eclipse.dev/paho/index.php?page=clients/python/docs/index.php (which isn't linked from anywhere in the repo).
• Inline function documentation, for example in the top of the client loop method, the strong recommendation about using the threaded loop methods.

Consistency, perhaps through using Sphinx or similar, would definitely help.

Reproduction

Search for up-to-date canonical documentation for paho.mqtt.python.

Environment

NA

Logs

NA

[PierreF]

This the aim of #804 which already merge README & docstring using Sphinx documentation.

I'll see what to do with https://eclipse.dev/paho (for the Python part) website.