Make the docs compatible with RTD and update README #266
Conversation
This file contains hidden or 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
It makes more sense to host API documentation and the long README we have in Read the Docs so that they become more visible and structured. Therefore, the long README is partitioned into chapters, a small introduction(docs/index.rst) is created, and API documentation is moved into a separate chapter. Also, API documentation of the HazelcastClient is constructed as a top-level chapter since it is generally the entry point for other documentation elements. Finally, the README we have in Github is made shorter and more descriptive. Also, added some badges to both README and docs/index.rst to make users easily navigate between PyPI, Read the Docs, and Github. The links to Read the Docs site (hazelcast.readthedocs.io) won't work right now, but I will set up this once this is merged.
puzpuzpuz
approved these changes
Dec 17, 2020
|
Left some comments, all nits. |
Contributor
Author
|
Thanks for the review Andrey |
mdumandag
added a commit
to mdumandag/hazelcast-python-client
that referenced
this pull request
Dec 18, 2020
As pointed out in the code review for hazelcast#266, there were unnecessary newlines around the top-level callback function definition, but we left it as it is since PEP8 recommends such newlines. Changed that part to use lambdas so that we can get rid of the newlines.
mdumandag
added a commit
to mdumandag/hazelcast-python-client
that referenced
this pull request
Dec 18, 2020
As pointed out in the code review for hazelcast#266, there were unnecessary newlines around the top-level callback function definition, but we left it as it is since PEP8 recommends such newlines. Changed that part to use lambdas so that we can get rid of the newlines.
mdumandag
added a commit
that referenced
this pull request
Dec 18, 2020
As pointed out in the code review for #266, there were unnecessary newlines around the top-level callback function definition, but we left it as it is since PEP8 recommends such newlines. Changed that part to use lambdas so that we can get rid of the newlines.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
It makes more sense to host API documentation and the long README
we have in Read the Docs so that they become more visible and
structured. Therefore, the long README is partitioned into chapters,
a small introduction(docs/index.rst) is created, and API documentation
is moved into a separate chapter. Also, API documentation of the
HazelcastClient is constructed as a top-level chapter since it is
generally the entry point for other documentation elements.
Finally, the README we have in Github is made shorter and
more descriptive. Also, added some badges to both README and
docs/index.rst to make users easily navigate between PyPI, Read the Docs,
and Github. The links to Read the Docs site (hazelcast.readthedocs.io)
won't work right now, but I will set up this once this is merged.
Closes #252