docgen iter 2
This commit is contained in:
11
soleprint/atlas2/docgen/emitters/__init__.py
Normal file
11
soleprint/atlas2/docgen/emitters/__init__.py
Normal file
@@ -0,0 +1,11 @@
|
||||
"""
|
||||
Emitters: IR -> an artifact. None of them has heard of Python, `ast` or SQL.
|
||||
|
||||
dot .dot -> Graphviz -> SVG static docs, embedding
|
||||
index markdown / sidebar JSON no graph literacy required
|
||||
diff two IRs -> what changed review
|
||||
notebook .ipynb a runnable document
|
||||
|
||||
The non-visual ones matter most for reach. A sorted, described index of what
|
||||
exists is readable by people who will never open a diagram.
|
||||
"""
|
||||
Reference in New Issue
Block a user