chore(docs): added generated docs for async client #947
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
mutianf
approved these changes
Mar 20, 2024
docs/usage.rst
Outdated
| @@ -1,5 +1,5 @@ | |||
| Using the API | |||
| ============= | |||
| Using the Standard Client | |||
There was a problem hiding this comment.
nit: standard client -> sync client?
There was a problem hiding this comment.
Eventually there will be two sync clients, so we'll need a different naming system. I'll change it to sync for now though, we can discuss that later!
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.
Added autogenerated sphinx docs pages for async data client
Currently serving them in the Using the API section:
To view docs locally:
nox -s docsto generate html pagespython -m http.server -d ./docs/_build/htmlto start a local server onlocalhost:8000BEGIN_COMMIT_OVERRIDE
chore(docs): added generated docs for async client
END_COMMIT_OVERRIDE