Update readme and example #804
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PierreF
force-pushed
the
update-readme-and-example
branch
from
2232100
to
60f5efc
Compare
This remove base62 and WebsocketWrapper
The class instance represent ONE reason code, it was odd to have a variable of type `ReasonCodes` (e.g. `rc: ReasonCodes`), when that variable was a single value.
Also remove all function documentation from README, they are moved exclusively to pydoc to avoid duplicating the documentations. The README should contains guide & examples, and pydoc contains reference documentations.
dnspython3 is deprecated and replaced by dnspython
This allow to have better print for a list of ReasonCodes, for example in on_subscribe callback.
Add markdown build to host the documentation using the Github repository.
PierreF
force-pushed
the
update-readme-and-example
branch
from
60f5efc
to
fb1b93b
Compare
|
The PR is based of #808 for conflict but also because I spotted those private objects while checking the documentation output. |
|
The documentation is now available online at https://eclipse.dev/paho/files/paho.mqtt.python/html/index.html |
dannystaple
reviewed
Feb 7, 2024
Co-authored-by: Danny Staple <danny@orionrobots.co.uk>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This update the README and examples:
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 ?)