docs(api): add social cards + add auto-generated documentation with mkdocstrings.

Author: qkaiser

default.nix

@@ -74,6 +74,7 @@ let
         arpy = overrideWithSetuptools super.arpy { };
         yaffshiv = overrideWithSetuptools super.yaffshiv { };
         ubi-reader = overrideWithSetuptools super.ubi-reader { };
+        cairosvg = overrideWithSetuptools super.cairocffi { };
       });
 
     python = python3;

docs/api.md

@@ -0,0 +1,33 @@
+---
+hide:
+  - navigation
+---
+
+# API Reference
+
+::: unblob.models.Handler
+    handler: python
+    options:
+      members:
+        - get_dependencies
+        - calculate_chunk
+        - extract
+      show_root_heading: true
+      show_source: true
+
+::: unblob.models.StructHandler
+    handler: python
+    options:
+      members:
+        - parse_header
+      show_root_heading: true
+      show_source: true
+
+::: unblob.models.Extractor
+    handler: python
+    options:
+      members:
+        - get_dependencies
+        - extract
+      show_root_heading: true
+      show_source: true

mkdocs.yml

@@ -14,6 +14,7 @@ nav:
   - Supported Formats: formats.md
   - extractors.md
   - development.md
+  - API: api.md
   - glossary.md
   - support.md
 
@@ -55,11 +56,13 @@ extra_css:
   - extra.css
 
 plugins:
+  - search
+  - mkdocstrings
   - social:
-    cards_color:
-      fill: "#002060"
-      text: "#00FFC8"
-    cards_font: Artegra Sans
+      cards: true
+      cards_color:
+        fill: "#002060"
+        text: "#00FFC8"
 
 extra:
   social: