add missign code references, add logo, other cleanups

jeffkala · jeffkala · commit 3dbda2d7b0b3 · 2025-08-22T14:46:27.000-06:00
diff --git a/docs/code-reference/jdiff/__init__.md b/docs/code-reference/jdiff/__init__.md
@@ -0,0 +1 @@
+::: jdiff
diff --git a/docs/code-reference/jdiff/check_types.md b/docs/code-reference/jdiff/check_types.md
@@ -0,0 +1 @@
+::: jdiff.check_types
diff --git a/docs/code-reference/jdiff/evaluators.md b/docs/code-reference/jdiff/evaluators.md
@@ -0,0 +1 @@
+::: jdiff.evaluators
diff --git a/docs/code-reference/jdiff/extract_data.md b/docs/code-reference/jdiff/extract_data.md
@@ -0,0 +1 @@
+::: jdiff.extract_data
diff --git a/docs/code-reference/jdiff/operator.md b/docs/code-reference/jdiff/operator.md
@@ -0,0 +1 @@
+::: jdiff.operator
diff --git a/docs/code-reference/jdiff/utils/__init__.md b/docs/code-reference/jdiff/utils/__init__.md
@@ -0,0 +1 @@
+::: jdiff.utils
diff --git a/docs/code-reference/jdiff/utils/data_normalization.md b/docs/code-reference/jdiff/utils/data_normalization.md
@@ -0,0 +1 @@
+::: jdiff.utils.data_normalization
diff --git a/docs/code-reference/jdiff/utils/diff_helpers.md b/docs/code-reference/jdiff/utils/diff_helpers.md
@@ -0,0 +1 @@
+::: jdiff.utils.diff_helpers
diff --git a/docs/code-reference/jdiff/utils/jmespath_parsers.md b/docs/code-reference/jdiff/utils/jmespath_parsers.md
@@ -0,0 +1 @@
+::: jdiff.utils.jmespath_parsers
diff --git a/docs/generate_code_reference_pages.py b/docs/generate_code_reference_pages.py
@@ -4,7 +4,7 @@
 
 import mkdocs_gen_files
 
-for file_path in Path("pyntc").rglob("*.py"):
+for file_path in Path("jdiff").rglob("*.py"):
     module_path = file_path.with_suffix("")
     doc_path = file_path.with_suffix(".md")
     full_doc_path = Path("code-reference", doc_path)
diff --git a/docs/images/jdiff_logo.png b/docs/images/jdiff_logo.png
diff --git a/jdiff/check_types.py b/jdiff/check_types.py
@@ -37,8 +37,8 @@ def evaluate(self, *args, **kwargs) -> Tuple[Dict, bool]:
         This method is the one that each CheckType has to implement.
 
         Args:
-            *args: arguments specific to child class implementation
-            **kwargs: named arguments
+            *args (tuple): arguments specific to child class implementation
+            **kwargs (dict): named arguments
 
         Returns:
             tuple: Dictionary representing check result, bool indicating if differences are found.
diff --git a/jdiff/utils/diff_helpers.py b/jdiff/utils/diff_helpers.py
@@ -13,10 +13,10 @@ def get_diff_iterables_items(diff_result: Mapping) -> DefaultDict:
     """Helper function for diff_generator to postprocess changes reported by DeepDiff for iterables.
 
     DeepDiff iterable_items are returned when the source data is a list
-    and provided in the format: "root['Ethernet3'][1]"
-    or more generically: root['KEY']['KEY']['KEY']...[numeric_index]
+    and provided in the format: `"root['Ethernet3'][1]"`
+    or more generically: `root['KEY']['KEY']['KEY']...[numeric_index]`
     where the KEYs are dict keys within the original object
-    and the "[index]" is appended to indicate the position within the list.
+    and the `"[index]"` is appended to indicate the position within the list.
 
     Args:
         diff_result: iterable comparison result from DeepDiff
@@ -52,10 +52,12 @@ def fix_deepdiff_key_names(obj: Mapping) -> Dict:
 
     Args:
         obj (Mapping): Mapping to be fixed. For example:
+            ```
             {
                 "root[3]['7.7.7.7']['is_enabled']": {'new_value': False, 'old_value': True},
                 "root[3]['7.7.7.7']['is_up']": {'new_value': False, 'old_value': True}
             }
+            ```
 
     Returns:
         Dict: aggregated output, for example: {'7.7.7.7': {'is_enabled': {'new_value': False, 'old_value': True},
@@ -107,10 +109,10 @@ def set_nested_value(data, keys, value):
     Args:
         data (dict): The nested dictionary to modify.
         keys (list): A list of keys to access the target value.
-        value: The value to set.
+        value (str): The value to set.
 
     Returns:
-        None: The function modifies the dictionary in place.  Returns None.
+        None (None): The function modifies the dictionary in place.  Returns None.
     """
     if not keys:
         return  # Should not happen, but good to have.
diff --git a/jdiff/utils/jmespath_parsers.py b/jdiff/utils/jmespath_parsers.py
@@ -135,10 +135,10 @@ def multi_reference_keys(jmspath: str, data):
     """Build a list of concatenated reference keys.
 
     Args:
-        jmspath: "$*$.peers.$*$.*.ipv4.[accepted_prefixes]"
-        data: tests/mock/napalm_get_bgp_neighbors/multi_vrf.json
+        jmspath (str): "$*$.peers.$*$.*.ipv4.[accepted_prefixes]"
+        data (dict): tests/mock/napalm_get_bgp_neighbors/multi_vrf.json
 
-    Returns:
+    Returns (str):
         ["global.10.1.0.0", "global.10.2.0.0", "global.10.64.207.255", "global.7.7.7.7", "vpn.10.1.0.0", "vpn.10.2.0.0"]
     """
     ref_key_regex = re.compile(r"\$.*?\$")
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -139,3 +139,13 @@ nav:
       - Contributing to the Library: "dev/contributing.md"
       - Development Environment: "dev/dev_environment.md"
       - Architecture Decisions: "dev/arch_decision.md"
+      - Code Reference:
+        - Jdiff: "code-reference/jdiff/__init__.md"
+        - check_types: "code-reference/jdiff/check_types.md"
+        - evaluators: "code-reference/jdiff/evaluators.md"
+        - extract_data: "code-reference/jdiff/extract_data.md"
+        - operator: "code-reference/jdiff/operator.md"
+        - jdiff_utils: "code-reference/jdiff/utils/__init__.md"
+        - data_normalization: "code-reference/jdiff/utils/data_normalization.md"
+        - diff_helpers: "code-reference/jdiff/utils/diff_helpers.md"
+        - jmespath_parsers: "code-reference/jdiff/utils/jmespath_parsers.md"
diff --git a/towncrier_templates.j2 b/towncrier_templates.j2
