chore: code refactor and docs update (#15)

* chore: moved docs from docusaurus to mkdocs

* updated change log

* code clean up

* chore: document update

* docs update

* fav icon changes

* readme update

Author: shyam-cb

README.md

@@ -21,11 +21,21 @@
 
 **Table of Contents**
 
+- [Breaking Changes in Version 2.0.0](#breaking-changes-in-version-200)
 - [Overview](#overview)
 - [Installation](#installation)
 - [Usage](#usage)
 - [License](#license)
 
+## Breaking Changes in Version 2.0.0
+
+> **Important Note:**  
+> In version 2.0.0, the following component names have been changed:
+> - `CouchbaseDocumentStore` is now `CouchbaseSearchDocumentStore`
+> - `CouchbaseEmbeddingRetriever` is now `CouchbaseSearchEmbeddingRetriever`
+>
+> Please update your code accordingly if upgrading from an earlier version.
+
 ## Overview
 
 An integration of [Couchbase](https://www.couchbase.com) NoSQL database with [Haystack v2.0](https://docs.haystack.deepset.ai/v2.0/docs/intro)

docs/reference/document_stores/auth.md

@@ -16,4 +16,4 @@
 ::: couchbase_haystack.document_stores.auth.CouchbaseCertificateAuthenticator
     options:
       show_root_heading: false
-      heading_level: 3 
+      heading_level: 3

docs/reference/document_stores/cluster_options.md

@@ -3,4 +3,4 @@
 ::: couchbase_haystack.document_stores.cluster_options.CouchbaseClusterOptions
     options:
       show_root_heading: false
-      heading_level: 2 
+      heading_level: 2

mkdocs.yaml

@@ -16,10 +16,7 @@ nav:
     - License: license.md
   - Code Reference:
     - CouchbaseSearchDocumentStore: reference/document_stores/document_store.md
-    - Authentication:
-      - CouchbaseAuthenticator: reference/document_stores/auth.md
-      - CouchbasePasswordAuthenticator: reference/document_stores/auth.md
-      - CouchbaseCertificateAuthenticator: reference/document_stores/auth.md
+    - Authentication: reference/document_stores/auth.md
     - CouchbaseClusterOptions: reference/document_stores/cluster_options.md
     - Retrievers:
       - CouchbaseSearchEmbeddingRetriever: reference/components/retrievers/embedding_retriever.md
@@ -29,6 +26,7 @@ nav:
 theme:
   name: material
   logo: assets/logo.svg
+  favicon: assets/logo.svg
   features:
     - navigation.tabs
     - navigation.tabs.sticky
@@ -77,7 +75,7 @@ plugins:
             - https://docs.python.org/3/objects.inv
             - https://mkdocstrings.github.io/objects.inv
             - https://mkdocstrings.github.io/griffe/objects.inv
-            - https://neo4j.com/docs/api/python-driver/current/objects.inv
+            - https://docs.couchbase.com/sdk-api/couchbase-python-client/objects.inv
           options:
             docstring_options:
               ignore_init_summary: yes

src/couchbase_haystack/components/retrievers/embedding_retriever.py

@@ -12,8 +12,7 @@
 
 @component
 class CouchbaseSearchEmbeddingRetriever:
-    """
-    Retrieves documents from the CouchbaseSearchDocumentStore by embedding similarity.
+    """Retrieves documents from the CouchbaseSearchDocumentStore by embedding similarity.
 
     The similarity is dependent on the vector_search_index used in the CouchbaseSearchDocumentStore and the chosen metric
     during the creation of the index (i.e. dot product, or l2 norm). See CouchbaseSearchDocumentStore for more
@@ -54,8 +53,7 @@ def __init__(
         document_store: CouchbaseSearchDocumentStore,
         top_k: int = 10,
     ):
-        """
-        Create the CouchbaseSearchDocumentStore component.
+        """Create the CouchbaseSearchDocumentStore component.
 
         Note: Currently, the filter option is not supported with embedding queries.
         Instead, you can provide a couchbase search query while running the embedding query.
@@ -76,10 +74,9 @@ def __init__(
         self.top_k = top_k
 
     def to_dict(self) -> Dict[str, Any]:
-        """
-        Serializes the component to a dictionary.
+        """Serializes the component to a dictionary.
 
-        :returns:
+        Returns:
             Dictionary with serialized data.
         """
         return default_to_dict(
@@ -90,13 +87,13 @@ def to_dict(self) -> Dict[str, Any]:
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "CouchbaseSearchDocumentStore":
-        """
-        Deserializes the component from a dictionary.
+        """Deserializes the component from a dictionary.
 
-        :param data:
-            Dictionary to deserialize from.
-        :returns:
-              Deserialized component.
+        Args:
+            data: Dictionary to deserialize from.
+
+        Returns:
+            Deserialized component.
         """
         data["init_parameters"]["document_store"] = CouchbaseSearchDocumentStore.from_dict(
             data["init_parameters"]["document_store"]
@@ -111,8 +108,7 @@ def run(
         search_query: Optional[SearchQuery] = None,
         limit: Optional[int] = None,
     ) -> Dict[str, List[Document]]:
-        """
-        Retrieve documents from the CouchbaseSearchDocumentStore, based on the provided embedding similarity.
+        """Retrieve documents from the CouchbaseSearchDocumentStore, based on the provided embedding similarity.
 
         Args:
             query_embedding: Embedding of the query.

src/couchbase_haystack/document_stores/auth.py

@@ -12,11 +12,12 @@ def get_cb_auth(self) -> Union[PasswordAuthenticator, CertificateAuthenticator]:
 
 
 class CouchbasePasswordAuthenticator(CouchbaseAuthenticator):
-    """
+    """Password-based authenticator for Couchbase.
+
     Args:
-        username (str): Username to use for authentication.
-        password (str): Password to use for authentication.
-        cert_path (str): Path of the certificate trust store. Defaults to None.
+        username: Username to use for authentication.
+        password: Password to use for authentication.
+        cert_path: Path of the certificate trust store. Defaults to None.
     """
 
     def __init__(
@@ -38,10 +39,9 @@ def get_cb_auth(self) -> PasswordAuthenticator:
         return PasswordAuthenticator(self.username.resolve_value(), self.password.resolve_value(), self.cert_path, **self.kwargs)
 
     def to_dict(self) -> Dict[str, Any]:
-        """
-        Serializes the component to a dictionary.
+        """Serializes the component to a dictionary.
 
-        :returns:
+        Returns:
             Dictionary with serialized data.
         """
         return default_to_dict(
@@ -54,26 +54,25 @@ def to_dict(self) -> Dict[str, Any]:
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "CouchbasePasswordAuthenticator":
-        """
-        Deserializes the component from a dictionary.
+        """Deserializes the component from a dictionary.
+
+        Args:
+            data: Dictionary to deserialize from.
 
-        :param data:
-            Dictionary to deserialize from.
-        :returns:
-              Deserialized component.
+        Returns:
+            Deserialized component.
         """
         deserialize_secrets_inplace(data["init_parameters"], keys=["username", "password"])
         return default_from_dict(cls, data)
 
 
 class CouchbaseCertificateAuthenticator(dict):
-    """
-    Certificate-based authenticator for Couchbase.
+    """Certificate-based authenticator for Couchbase.
 
     Args:
-        cert_path (str): Path to the client certificate file. Defaults to None.
-        key_path (str): Path to the client key file. Defaults to None.
-        trust_store_path (str): Path to the certificate trust store. Defaults to None.
+        cert_path: Path to the client certificate file. Defaults to None.
+        key_path: Path to the client key file. Defaults to None.
+        trust_store_path: Path to the certificate trust store. Defaults to None.
     """
 
     def __init__(self, cert_path: Optional[str] = None, key_path: Optional[str] = None, trust_store_path: Optional[str] = None):
@@ -91,22 +90,21 @@ def get_cb_auth(self) -> CertificateAuthenticator:
         return CertificateAuthenticator(cert_path=self.cert_path, key_path=self.key_path, trust_store_path=self.trust_store_path)
 
     def to_dict(self) -> Dict[str, Any]:
-        """
-        Serializes the component to a dictionary.
+        """Serializes the component to a dictionary.
 
-        :returns:
+        Returns:
             Dictionary with serialized data.
         """
         return default_to_dict(self, cert_path=self.cert_path, key_path=self.key_path, trust_store_path=self.trust_store_path)
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "CouchbaseCertificateAuthenticator":
-        """
-        Deserializes the component from a dictionary.
+        """Deserializes the component from a dictionary.
+
+        Args:
+            data: Dictionary to deserialize from.
 
-        :param data:
-            Dictionary to deserialize from.
-        :returns:
-              Deserialized component.
+        Returns:
+            Deserialized component.
         """
         return default_from_dict(cls, data)

src/couchbase_haystack/document_stores/cluster_options.py

@@ -8,6 +8,8 @@
 
 
 class CouchbaseClusterOptions(dict):
+    """ClusterOptions is a dictionary that contains the options for the Couchbase cluster."""
+
     __cluster_level_timedelta_fields: ClassVar[List[str]] = [
         "tcp_keep_alive_interval",
         "config_poll_interval",
@@ -136,18 +138,87 @@ def __init__(
         disable_mozilla_ca_certificates: Optional[bool] = None,
         dump_configuration: Optional[bool] = None,
     ):
-        """ClusterOptions instance."""
+        """Initialize CouchbaseClusterOptions with explicit parameters.
+
+        Args:
+            profile: The profile to use for the Couchbase cluster. Defaults to None.
+            bootstrap_timeout: The timeout for the bootstrap operation. Defaults to None.
+            resolve_timeout: The timeout for the resolve operation. Defaults to None.
+            connect_timeout: The timeout for the connect operation. Defaults to None.
+            kv_timeout: The timeout for the KV operation. Defaults to None.
+            kv_durable_timeout: The timeout for the KV durable operation. Defaults to None.
+            views_timeout: The timeout for the views operation. Defaults to None.
+            query_timeout: The timeout for the query operation. Defaults to None.
+            analytics_timeout: The timeout for the analytics operation. Defaults to None.
+            search_timeout: The timeout for the search operation. Defaults to None.
+            management_timeout: The timeout for the management operation. Defaults to None.
+            dns_srv_timeout: The timeout for the DNS SRV operation. Defaults to None.
+            idle_http_connection_timeout: The timeout for idle HTTP connections. Defaults to None.
+            config_idle_redial_timeout: The timeout for idle config redials. Defaults to None.
+            config_total_timeout: The total timeout for config operations. Defaults to None.
+            tracing_threshold_kv: The threshold for KV tracing. Defaults to None.
+            tracing_threshold_view: The threshold for view tracing. Defaults to None.
+            tracing_threshold_query: The threshold for query tracing. Defaults to None.
+            tracing_threshold_search: The threshold for search tracing. Defaults to None.
+            tracing_threshold_analytics: The threshold for analytics tracing. Defaults to None.
+            tracing_threshold_eventing: The threshold for eventing tracing. Defaults to None.
+            tracing_threshold_management: The threshold for management tracing. Defaults to None.
+            tracing_threshold_queue_size: The queue size for tracing threshold. Defaults to None.
+            tracing_threshold_queue_flush_interval: The interval for tracing threshold queue flushing. Defaults to None.
+            tracing_orphaned_queue_size: The queue size for tracing orphaned events. Defaults to None.
+            tracing_orphaned_queue_flush_interval: The interval for tracing orphaned queue flushing. Defaults to None.
+            enable_tls: Whether to enable TLS. Defaults to None.
+            enable_mutation_tokens: Whether to enable mutation tokens. Defaults to None.
+            enable_tcp_keep_alive: Whether to enable TCP keep-alive. Defaults to None.
+            ip_protocol: The IP protocol to use. Defaults to None.
+            enable_dns_srv: Whether to enable DNS SRV. Defaults to None.
+            show_queries: Whether to show queries. Defaults to None.
+            enable_unordered_execution: Whether to enable unordered execution. Defaults to None.
+            enable_clustermap_notification: Whether to enable clustermap notification. Defaults to None.
+            enable_compression: Whether to enable compression. Defaults to None.
+            enable_tracing: Whether to enable tracing. Defaults to None.
+            enable_metrics: Whether to enable metrics. Defaults to None.
+            network: The network to use. Defaults to None.
+            tls_verify: The TLS verification mode. Defaults to None.
+            tcp_keep_alive_interval: The interval for TCP keep-alive. Defaults to None.
+            config_poll_interval: The interval for config polling. Defaults to None.
+            config_poll_floor: The floor for config polling. Defaults to None.
+            max_http_connections: The maximum number of HTTP connections. Defaults to None.
+            user_agent_extra: Extra user agent information. Defaults to None.
+            logging_meter_emit_interval: The interval for logging meter emission. Defaults to None.
+            log_redaction: Whether to redact logs. Defaults to None.
+            compression: The compression to use. Defaults to None.
+            compression_min_size: The minimum size for compression. Defaults to None.
+            compression_min_ratio: The minimum ratio for compression. Defaults to None.
+            dns_nameserver: The DNS nameserver to use. Defaults to None.
+            dns_port: The DNS port to use. Defaults to None.
+            disable_mozilla_ca_certificates: Whether to disable Mozilla CA certificates. Defaults to None.
+            dump_configuration: Whether to dump configuration. Defaults to None.
+        """
 
     @overload
     def __init__(self, **kwargs):
-        """ClusterOptions instance."""
+        """Initialize CouchbaseClusterOptions with keyword arguments.
+
+        Any parameter accepted by the explicit overload can be passed as a keyword argument.
+        """
 
     def __init__(self, **kwargs):
+        """Initialize CouchbaseClusterOptions by passing all keyword arguments to the parent dictionary class."""
         super().__init__(**kwargs)
 
     def get_cluster_options(
         self, auth: Union[CouchbasePasswordAuthenticator, CouchbaseCertificateAuthenticator]
     ) -> "ClusterOptions":
+        """Creates a ClusterOptions object with the provided authenticator.
+
+        Args:
+            auth: The authenticator to use for the Couchbase cluster.
+
+        Returns:
+            A ClusterOptions object configured with the provided authenticator and any other options.
+        """
+
         options = list(self.keys())
         obj = {}
         obj["authenticator"] = auth
@@ -156,13 +227,11 @@ def get_cluster_options(
         return ClusterOptions(**obj)
 
     def to_dict(self) -> Dict[str, Any]:
-        """
-        Serializes the component to a dictionary.
+        """Serializes the component to a dictionary.
 
-        :returns:
+        Returns:
             Dictionary with serialized data.
         """
-
         obj: Dict[str, Any] = {}
 
         # cluster level direct fields includes timeout and trace as they are flattened
@@ -184,14 +253,14 @@ def to_dict(self) -> Dict[str, Any]:
         return default_to_dict(self, **obj)
 
     @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> "ClusterOptions":
-        """
-        Deserializes the component from a dictionary.
+    def from_dict(cls, data: Dict[str, Any]) -> "CouchbaseClusterOptions":
+        """Deserializes the component from a dictionary.
+
+        Args:
+            data: Dictionary to deserialize from.
 
-        :param data:
-            Dictionary to deserialize from.
-        :returns:
-              Deserialized component.
+        Returns:
+            Deserialized component.
         """
         obj = {}
         # cluster level direct fields includes timeout and trace as they are flattened