updated docs strings and added README.md

docforge/renderers/base.py

@@ -1,9 +1,11 @@
 """
+# Summary
+
 Renderer base interfaces and configuration models.
 
 This module defines the base protocol and configuration container used by
 doc-forge renderers. Concrete renderer implementations should implement the
-``DocRenderer`` protocol.
+`DocRenderer` protocol.
 """
 
 from pathlib import Path
@@ -16,12 +18,15 @@ class RendererConfig:
     """
     Configuration container for documentation renderers.
 
-    A ``RendererConfig`` instance groups together the project model and the
+    A `RendererConfig` instance groups together the project model and the
     output directory used during rendering.
 
     Attributes:
-        out_dir: Directory where generated documentation files will be written.
-        project: Documentation project model to be rendered.
+        out_dir (Path):
+            Directory where generated documentation files will be written.
+
+        project (Project):
+            Documentation project model to be rendered.
     """
 
     def __init__(self, out_dir: Path, project: Project) -> None:
@@ -29,8 +34,11 @@ class RendererConfig:
         Initialize a RendererConfig instance.
 
         Args:
-            out_dir: Target directory where documentation files should be written.
-            project: Introspected project model to render.
+            out_dir (Path):
+                Target directory where documentation files should be written.
+
+            project (Project):
+                Introspected project model to render.
         """
         self.out_dir = out_dir
         self.project = project
@@ -41,7 +49,7 @@ class DocRenderer(Protocol):
     Protocol defining the interface for documentation renderers.
 
     Implementations of this protocol are responsible for transforming a
-    ``Project`` model into renderer-specific documentation sources.
+    `Project` model into renderer-specific documentation sources.
     """
 
     name: str
@@ -55,8 +63,10 @@ class DocRenderer(Protocol):
         Generate renderer-specific documentation sources.
 
         Args:
-            project: Project model containing modules and documentation objects.
-            out_dir: Directory where generated documentation sources
-                should be written.
+            project (Project):
+                Project model containing modules and documentation objects.
+
+            out_dir (Path):
+                Directory where generated documentation sources should be written.
         """
         ...