xo-indentlog: doc: add indentlog docs [WIP]

2025-07-13 21:18:15 -05:00 · 2025-07-13 21:18:15 -05:00 · 7ddb79fadd
commit 7ddb79fadd
parent 28172fc3d6
12 changed files with 560 additions and 0 deletions
--- a/docs/pretty_impl.rst
+++ b/docs/pretty_impl.rst
@ -0,0 +1,37 @@
+.. _pretty_impl:
+
+Pretty Printer
+==============
+
+Abstraction tower for *xo-indentlog* pretty-printer:
+
+.. ditaa::
+    :--scale: 0.85
+
+    +--------------------+
+    |      toppstr       |
+    +--------------------+
+    |      ppdetail      |
+    +--------------------+
+    |      ppstate       |
+    +--------------------+
+    |      ppconfig      |
+    +--------------------+
+
+**toppstr**
+    Pretty print arguments to string.
+
+**ppdetail**
+    Template for Type-specific pretty-printing.
+
+**ppstate**
+    Temporary state object. Created once for each top-level pretty-print call
+
+**ppconfig**
+    Pretty-printer configuration.
+
+.. toctree::
+   :maxdepth: 1
+
+   ppstr functions <ppstr-reference>
+   ppconfig class <ppconfig-reference>