Merge pull request #307 from sanders41/doc-strings

Change docs to from mkautodocs to mkdocstrings

.pre-commit-config.yaml

@@ -28,5 +28,5 @@ repos:
     rev: 5.0.4
     hooks:
     - id: flake8
-      additional_dependencies: [flake8-docstrings, flake8-print]
+      additional_dependencies: [flake8-print]
       args: ["--ignore=E203,E231,E501,D100,D101,D102,D103,D104,D105,D106,D107,D401"]

docs/client_api.md

@@ -0,0 +1,36 @@
+## `Client Usage`
+
+### Create a client with a context manager
+
+This client runs in a context manager which ensures that everything is cleaned up after the use of
+the client is done. To create a client:
+
+```py
+from milisearch-python-async import Client
+
+
+async with Client("http://localhost:7700", "masterKey") as client:
+    index = client.index("movies")
+    ...
+```
+
+### Create a client without a context manager
+
+It is also possible to call the client without using a context manager, but in doing so you will
+need to make sure to do the cleanup yourself:
+
+```py
+from meilisearch-python-async import Client
+
+
+try:
+    client = Client("http://localhost:7700", "masterKey")
+    ...
+finally:
+    await client.aclose()
+
+```
+
+## `Client API`
+
+::: meilisearch_python_async.client.Client

docs/index_api.md

@@ -0,0 +1,3 @@
+## `Index`
+
+::: meilisearch_python_async.index.Index

docs/tasks_api.md

@@ -0,0 +1,3 @@
+## Tasks
+
+::: meilisearch_python_async.task