Add New API to Docs #361
Merged
Add New API to Docs #361
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
✅ Deploy Preview for poetic-froyo-8baba7 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…nformation about async versions
* feat(pyproject.toml): add dependencies for documentation group
* fix(pyproject.toml): fix typo in Pygments dependency version
…ns and fix newline at end of file
…e [Python] * docs(index.rst): update Qdrant Client Documentation description to include vector search engine * docs(index.rst): update recreate_collection code example to include vectors_config parameter
* docs(index.rst): remove unnecessary link to test file in async mode section * docs(index.rst): add missing classes to API Reference section
…nd Search without `fastembed`" to "Qdrant without `fastembed`"
|
Fixes #355 |
joein
reviewed
Nov 1, 2023
joein
reviewed
Nov 1, 2023
joein
reviewed
Nov 1, 2023
joein
reviewed
Nov 1, 2023
| - :meth:`QdrantClient.grpc_points` | ||
| - :meth:`QdrantClient.grpc_collections` | ||
| - :meth:`QdrantClient.rest` | ||
| - :py:attr:`QdrantClient.grpc_points` |
There was a problem hiding this comment.
I am wondering if QdrantClient can be replaced with some reference to the class itself? (not sure if it is possible in sphinx)
I am worried because AsyncQdrantClient has links to the properties of QdrantClient :( (and I started thinking about the ways to handle it)
joein
approved these changes
Nov 1, 2023
joein
pushed a commit
that referenced
this pull request
Nov 3, 2023
* * chore(.gitignore): add docs/source/examples/*/*/* to ignore list * * feat(docs): add new modules and subpackages to qdrant_client documentation * * docs(qdrant_client): update QdrantClient documentation to include information about async versions * * docs(index.rst): update link to complete client API docs * * chore(pyproject.toml): remove unused dependencies from dev group * feat(pyproject.toml): add dependencies for documentation group * * chore(pyproject.toml): update ipython dependency version to 8 * fix(pyproject.toml): fix typo in Pygments dependency version * * chore(generate_docs_netlify.sh): remove unnecessary pip installations and fix newline at end of file * * docs(index.rst): update Qdrant Client Documentation title to include [Python] * docs(index.rst): update Qdrant Client Documentation description to include vector search engine * docs(index.rst): update recreate_collection code example to include vectors_config parameter * * docs(index.rst): add code samples for async client support * * chore(conf.py): exclude grpc and tests directories from documentation build * * docs(index.rst): fix title of Qdrant Python Client Documentation * docs(index.rst): remove unnecessary link to test file in async mode section * docs(index.rst): add missing classes to API Reference section * * chore(conf.py): exclude local directory from documentation generation * * docs(quickstart.ipynb): update section title from "Points, Upsert and Search without `fastembed`" to "Qdrant without `fastembed`" * * chore(conf.py): exclude tests from documentation by updating exclude_patterns
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.
Asyncinformation to index.rst