updated doc strings

docforge/nav/mkdocs.py

@@ -1,7 +1,9 @@
 """
-This module provides the MkDocsNavEmitter, which converts a ResolvedNav instance
-into the specific YAML-ready list structure expected by the MkDocs 'nav'
-configuration.
+MkDocs navigation emitter.
+
+This module provides the ``MkDocsNavEmitter`` class, which converts a
+``ResolvedNav`` instance into the navigation structure required by the
+MkDocs ``nav`` configuration.
 """
 
 from pathlib import Path
@@ -12,19 +14,24 @@ from docforge.nav.resolver import ResolvedNav
 
 class MkDocsNavEmitter:
     """
-    Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible
-    navigation structure.
+    Emit MkDocs navigation structures from resolved navigation data.
+
+    The emitter transforms a ``ResolvedNav`` object into the YAML-compatible
+    list structure expected by the MkDocs ``nav`` configuration field.
     """
 
     def emit(self, nav: ResolvedNav) -> List[Dict[str, Any]]:
         """
-        Generate a list of navigation entries for mkdocs.yml.
+        Generate a navigation structure for ``mkdocs.yml``.
 
         Args:
-            nav: The resolved navigation data.
+            nav: Resolved navigation data describing documentation groups
+                and their associated Markdown files.
 
         Returns:
-            A list of dictionary mappings representing the MkDocs navigation.
+            A list of dictionaries representing the MkDocs navigation layout.
+            Each dictionary maps a navigation label to a page or a list of
+            pages.
         """
         result: List[Dict[str, Any]] = []
 
@@ -45,16 +52,18 @@ class MkDocsNavEmitter:
 
     def _to_relative(self, path: Path, docs_root: Path | None) -> str:
         """
-        Convert a filesystem path to a path relative to the documentation root.
-        This handles both absolute and relative filesystem paths, ensuring the
-        output is compatible with MkDocs navigation requirements.
+        Convert a filesystem path into a documentation-relative path.
+
+        This method normalizes paths so they can be used in MkDocs navigation.
+        It handles both absolute and relative filesystem paths and ensures the
+        resulting path is relative to the documentation root.
 
         Args:
-            path: The path to convert.
-            docs_root: The root directory for documentation.
+            path: Filesystem path to convert.
+            docs_root: Root directory of the documentation sources.
 
         Returns:
-            A string representing the relative POSIX-style path.
+            POSIX-style path relative to the documentation root.
         """
         if docs_root and path.is_absolute():
             try:
@@ -67,6 +76,6 @@ class MkDocsNavEmitter:
             docs_root_str = docs_root.as_posix()
             if path_str.startswith(docs_root_str + "/"):
                 return path_str[len(docs_root_str) + 1:]
-        
+
         # Fallback for other cases
         return path.as_posix().split("/docs/", 1)[-1]