Merge branch 'main' into update-release-v0.22.1

Author: alallema

.github/workflows/documentation.yml

@@ -19,8 +19,8 @@ jobs:
     - name: Install pipenv
       uses: dschep/install-pipenv-action@v1
     - name: Install dependencies
-      run: pipenv install --dev    
-    - name: Build docs      
+      run: pipenv install --dev
+    - name: Build docs
       uses: ammaraskar/sphinx-action@master
       with:
         pre-build-command: "pip install sphinx_rtd_theme && sphinx-apidoc -f -o docs meilisearch/"
@@ -30,16 +30,4 @@ jobs:
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: docs/_build/html
-        force_orphan: true   
-
-
-
-
-
-
-
-      
-
-
-
-
+        force_orphan: true

Pipfile.lock

@@ -46,7 +46,7 @@ You’d like to contribute? Don’t hesitate to check out our [contributing guid
 
 ## 📖 Documentation
 
-See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
+To learn more about Meilisearch Python, refer to the in-depth [Meilisearch Python documentation](https://meilisearch.github.io/meilisearch-python/). To learn more about Meilisearch in general, refer to our [documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html) or our [API reference](https://docs.meilisearch.com/reference/api/overview.html).
 
 ## 🔧 Installation
 

README.md

@@ -52,4 +52,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = []
+
+# This value contains a list of modules to be mocked up.
+autodoc_mock_imports = ["camel_converter"]

docs/conf.py

@@ -4,6 +4,14 @@ meilisearch.models package
 Submodules
 ----------
 
+meilisearch.models.client module
+--------------------------------
+
+.. automodule:: meilisearch.models.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 meilisearch.models.document module
 ----------------------------------
 
@@ -20,6 +28,14 @@ meilisearch.models.index module
    :undoc-members:
    :show-inheritance:
 
+meilisearch.models.ressource module
+-----------------------------------
+
+.. automodule:: meilisearch.models.ressource
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 meilisearch.models.task module
 ------------------------------
 

docs/meilisearch.models.rst

@@ -18,7 +18,7 @@
     long_description_content_type="text/markdown",
     url="https://github.com/meilisearch/meilisearch-python",
     packages=find_packages(exclude=("tests*",)),
-    project_urls={"Documentation": "https://docs.meilisearch.com/",},
+    project_urls={"Meilisearch Documentation": "https://docs.meilisearch.com/", "Documentation": "https://meilisearch.github.io/meilisearch-python/",},
     keywords="search python meilisearch",
     platform="any",
     classifiers=[