fix: min max zoom arg doc and doc building (#1523)

Co-authored-by: theodu <[email protected]>

.github/workflows/ci.yml

@@ -9,22 +9,22 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: 3.8
-          cache: 'pip'
+          cache: "pip"
       - uses: pre-commit/[email protected]
 
   pylint:
     runs-on: ubuntu-latest
     name: Pylint test
     strategy:
       matrix:
-        python-version: ['3.8', '3.11']
+        python-version: ["3.8", "3.11"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
+          cache: "pip"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -37,13 +37,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ['3.8', '3.11']
+        version: ["3.8", "3.11"]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.version }}
-          cache: 'pip'
+          cache: "pip"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -72,7 +72,7 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
+          cache: "pip"
 
       - name: Install dependencies
         run: |
@@ -138,4 +138,16 @@ jobs:
           pip install -e ".[dev]"
 
       - name: Build
-        run: mkdocs build
+        run: |
+          mkdocs build
+
+      - name: Look for Warnings
+        run: |
+          mkdocs build 2>&1 | tee doc-build.log
+          if grep -q "WARNING" doc-build.log; then
+            echo $(grep "WARNING" doc-build.log)
+            echo "::error::Documentation build completed with warnings"
+            exit 1
+          else
+            echo "Documentation build completed successfully"
+          fi

docs/sdk/issue.md

@@ -1,5 +1,3 @@
 # Issue module
 
 ::: kili.presentation.client.issue.IssueClientMethods
-::: kili.entrypoints.queries.issue.__init__.QueriesIssue
-::: kili.entrypoints.mutations.issue.__init__.MutationsIssue

docs/sdk/project.md

@@ -2,6 +2,4 @@
 
 ::: kili.presentation.client.project.ProjectClientMethods
 
-::: kili.entrypoints.queries.project.__init__.QueriesProject
-
 ::: kili.entrypoints.mutations.project.__init__.MutationsProject

src/kili/entrypoints/mutations/asset/__init__.py

@@ -84,7 +84,9 @@ def append_many_to_dataset(
                     Example for one asset: `json_metadata_array = [{'imageUrl': '','text': '','url': ''}]`.
                 - For VIDEO projects (and not VIDEO_LEGACY), you can specify a value with key 'processingParameters' to specify the sampling rate (default: 30).
                     Example for one asset: `json_metadata_array = [{'processingParameters': {'framesPlayedPerSecond': 10}}]`.
-                - For Image projects, if you work with geotiff, you can specify a value with key 'processingParameters' to specify the minimum and maximum zoom level.
+                - In Image projects with geoTIFF assets, you can specify the `minZoom` and `maxZoom` values for the `processingParameters` key.
+                    The `minZoom` parameter defines the zoom level that users are not allowed to zoom out from.
+                    The `maxZoom` value affects asset generation: the higher the value, the greater the level of details and the size of the asset.
                     Example for one asset: `json_metadata_array = [{'processingParameters': {'minZoom': 17, 'maxZoom': 19}}]`.
             disable_tqdm: If `True`, the progress bar will be disabled
             wait_until_availability: If `True`, the function will return once the assets are fully imported in Kili.