Minor - Missing OpenSearch in docs

Author: jaidisido

awswrangler/opensearch/_read.py

@@ -59,22 +59,22 @@ def search(
         A comma-separated list of index names to search.
         use `_all` or empty string to perform the operation on all indices.
     search_body : Dict[str, Any], optional
-        The search definition using the [Query DSL](https://opensearch.org/docs/opensearch/query-dsl/full-text/).
+        The search definition using the `Query DSL <https://opensearch.org/docs/opensearch/query-dsl/full-text/>`_.
     doc_type : str, optional
         Name of the document type (for Elasticsearch versions 5.x and earlier).
     is_scroll : bool, optional
         Allows to retrieve a large numbers of results from a single search request using
-        [scroll](https://opensearch.org/docs/opensearch/rest-api/scroll/)
+        `scroll <https://opensearch.org/docs/opensearch/rest-api/scroll/>`_
         for example, for machine learning jobs.
         Because scroll search contexts consume a lot of memory, we suggest you don’t use the scroll operation
         for frequent user queries.
     filter_path : Union[str, Collection[str]], optional
         Use the filter_path parameter to reduce the size of the OpenSearch Service response \
 (default: ['hits.hits._id','hits.hits._source'])
     **kwargs :
-        KEYWORD arguments forwarded to [opensearchpy.OpenSearch.search]\
-(https://opensearch-py.readthedocs.io/en/latest/api.html#opensearchpy.OpenSearch.search)
-        and also to [opensearchpy.helpers.scan](https://opensearch-py.readthedocs.io/en/master/helpers.html#scan)
+        KEYWORD arguments forwarded to `opensearchpy.OpenSearch.search \
+<https://opensearch-py.readthedocs.io/en/latest/api.html#opensearchpy.OpenSearch.search>`_
+        and also to `opensearchpy.helpers.scan <https://opensearch-py.readthedocs.io/en/master/helpers.html#scan>`_
          if `is_scroll=True`
 
     Returns
@@ -122,7 +122,7 @@ def search(
 
 
 def search_by_sql(client: OpenSearch, sql_query: str, **kwargs: Any) -> pd.DataFrame:
-    """Return results matching [SQL query](https://opensearch.org/docs/search-plugins/sql/index/) as pandas dataframe.
+    """Return results matching `SQL query <https://opensearch.org/docs/search-plugins/sql/index/>`_ as pandas dataframe.
 
     Parameters
     ----------

awswrangler/opensearch/_utils.py

@@ -45,10 +45,10 @@ def connect(
 
     Note
     ----
-    We use [opensearch-py](https://github.com/opensearch-project/opensearch-py), an OpenSearch low-level python client.
+    We use `opensearch-py <https://github.com/opensearch-project/opensearch-py>`_, an OpenSearch python client.
 
-    The username and password are mandatory if the OS Cluster uses [Fine Grained Access Control]\
-(https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html).
+    The username and password are mandatory if the OS Cluster uses `Fine Grained Access Control \
+<https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html>`_.
     If fine grained access control is disabled, session access key and secret keys are used.
 
     Parameters

awswrangler/opensearch/_write.py

@@ -275,7 +275,7 @@ def index_json(
     json_path : str, optional
         JsonPath expression to specify explicit path to a single name element
         in a JSON hierarchical data structure.
-        Read more about [JsonPath](https://jsonpath.com)
+        Read more about `JsonPath <https://jsonpath.com>`_
     boto3_session : boto3.Session(), optional
         Boto3 Session to be used to access s3 if s3 path is provided.
         The default boto3 Session will be used if boto3_session receive None.

docs/source/api.rst

@@ -10,6 +10,7 @@ API Reference
 * `Microsoft SQL Server`_
 * `Data API Redshift`_
 * `Data API RDS`_
+* `OpenSearch`_
 * `DynamoDB`_
 * `Amazon Timestream`_
 * `Amazon EMR`_
@@ -199,6 +200,24 @@ Data API RDS
     connect
     read_sql_query
 
+OpenSearch
+----------
+
+.. currentmodule:: awswrangler.opensearch
+
+.. autosummary::
+    :toctree: stubs
+
+    connect
+    create_index
+    delete_index
+    index_csv
+    index_documents
+    index_df
+    index_json
+    search
+    search_by_sql
+
 DynamoDB
 --------