🔧 add sphinx to pre-commit

Author: sebastianMindee

.github/workflows/_static-analysis.yml

@@ -52,5 +52,7 @@ jobs:
           ${{ runner.os }}-prec-
 
     - name: Run all static analysis
+      env:
+        SKIP: sphinx-html,sphinx-linkcheck
       run: |
         pre-commit run --all-files

.pre-commit-config.yaml

@@ -41,3 +41,18 @@ repos:
           - types-setuptools
           - importlib-metadata
           - types-Pillow
+  - repo: local
+    hooks:
+      - id: sphinx-html
+        name: Sphinx HTML build
+        entry: make -C docs html
+        language: system
+        pass_filenames: false
+        files: ^docs/.*$|^mindee/.*\.py$
+
+      - id: sphinx-linkcheck
+        name: Sphinx Linkcheck
+        entry: make -C docs linkcheck
+        language: system
+        pass_filenames: false
+        files: ^docs/.*$|^mindee/.*\.py$

mindee/v2/parsing/inference/field/inference_fields.py

@@ -42,21 +42,21 @@ def __str__(self) -> str:
         return str_fields
 
     def get_simple_field(self, field_name: str) -> "SimpleField":
-        """Retrieve the value of a simple field by its name."""
+        """Retrieve a simple field by its name."""
         field = self.get(field_name)
         if field and field.field_type == FieldType.SIMPLE:
             return cast("SimpleField", field)
         raise ValueError(f"Field {field_name} is not a SimpleField.")
 
     def get_object_field(self, field_name: str) -> "ObjectField":
-        """Retrieve the value of an object field by its name."""
+        """Retrieve an object field by its name."""
         field = self.get(field_name)
         if field and field.field_type == FieldType.OBJECT:
             return cast("ObjectField", field)
         raise ValueError(f"Field {field_name} is not an ObjectField.")
 
     def get_list_field(self, field_name: str) -> "ListField":
-        """Retrieve the value of a list field by its name."""
+        """Retrieve a list field by its name."""
         field = self.get(field_name)
         if field and field.field_type == FieldType.LIST:
             return cast("ListField", field)

mindee/v2/parsing/inference/field/object_field.py

@@ -1,7 +1,7 @@
 from collections.abc import Callable
 from typing import TYPE_CHECKING, cast
 
-from mindee.parsing.common import StringDict
+from mindee.parsing.common.string_dict import StringDict
 from mindee.v2.parsing.inference.field.base_field import BaseField, FieldType
 from mindee.v2.parsing.inference.field.inference_fields import InferenceFields
 
@@ -51,7 +51,7 @@ def simple_fields(self) -> dict[str, "SimpleField"]:
         Extract and return all SimpleField fields from the `fields` attribute.
 
         :return: A dictionary containing all fields that have a type of
-        `FieldType.SIMPLE`.
+            `FieldType.SIMPLE`.
         """
         simple_fields = {}
         for field_key, field_value in self.fields.items():
@@ -80,8 +80,8 @@ def object_fields(self) -> dict[str, "ObjectField"]:
         Retrieves all ObjectField fields from the `fields` attribute of the instance.
 
         :returns: A dictionary containing fields of type `FieldType.OBJECT`. The keys
-        represent
-            the field names, and the values are corresponding ObjectField objects.
+            represent the field names, and the values are corresponding ObjectField
+            objects.
         """
         object_fields = {}
         for field_key, field_value in self.fields.items():
@@ -123,7 +123,7 @@ def get_object_field(self, field_name: str) -> "ObjectField":
         :type field_name: str
         :return: The `ObjectField` associated with the given field name.
         :raises ValueError: If the field specified by `field_name` is not an
-        `ObjectField`.
+            `ObjectField`.
         """
         if self.fields[field_name].field_type != FieldType.OBJECT:
             raise ValueError(f"Field {field_name} is not an ObjectField.")