Merge #553

553: Fix - modules documentation are not generated properly r=alallema a=alallema

Some module wasn't generated because of this error:
```bash
WARNING: autodoc: failed to import module 'client' from module 'meilisearch'; the following exception was raised:
No module named 'camel_converter'
```

Co-authored-by: alallema <[email protected]>
Co-authored-by: Amélie <[email protected]>

Author: bors[bot]

.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

docs/conf.py

@@ -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/meilisearch.models.rst

@@ -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
 ------------------------------