Add server to norecursedirs, add doctstring for the endpoint method

docs/documentation/server.md

@@ -1,5 +1,5 @@
 # Serve the embeddings of a PyLate model
-The ```server.py``` script allows to create a FastAPI server to serve the embeddings of a PyLate model.
+The ```server.py``` script (located in the ```server``` folder) allows to create a FastAPI server to serve the embeddings of a PyLate model.
 To use it, you need to install the api dependencies: ```pip install "pylate[api]"```
 Then, run ```python server.py``` to launch the server.
 

pylate/server/server.py

@@ -86,6 +86,13 @@ def parse_args():
 
 @app.post("/v1/embeddings", response_model=EmbeddingResponse)
 async def create_embedding(request: EmbeddingRequest):
+    """API endpoint that encode the elements of an EmbeddingRequest and returns an EmbeddingResponse.
+
+    Parameters
+    ----------
+    request
+        The EmbeddingRequest containing the elements to encode, the model to use, and whether the input is a query or a document.
+    """
     if request.model != args.model:
         raise HTTPException(
             status_code=400,

pytest.ini

@@ -14,6 +14,7 @@ norecursedirs =
     build
     docs
     node_modules
+    pylate/server
 markers =
     web: tests that require using the Internet
     slow: tests that take a long time to run