aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated hexa and docforge docs

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-15 16:53:19 +05:30
parent 27f76c7831
commit b1f5ce092a
78 changed files with 2653 additions and 54095 deletions
Download Patch File Download Diff File Expand all files Collapse all files

369
hexa/lib/design/index.html
View File

@@ -9,10 +9,6 @@
<link rel="prev" href="..">
<link rel="next" href="../philosophy/">
<link rel="icon" href="../assets/images/favicon.png">
@@ -245,323 +241,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#file-map-samplesextraction_pipeline" class="md-nav__link">
<span class="md-ellipsis">
File map (samples/extraction_pipeline/)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#the-port-tree-abc-contract" class="md-nav__link">
<span class="md-ellipsis">
The port tree (ABC contract)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#generic-default-impl" class="md-nav__link">
<span class="md-ellipsis">
Generic default (Impl*)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bank-variation-only-what-differs" class="md-nav__link">
<span class="md-ellipsis">
Bank variation (only what differs)
</span>
</a>
<nav class="md-nav" aria-label="Bank variation (only what differs)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#axis-banksaxispdfpy" class="md-nav__link">
<span class="md-ellipsis">
Axis (banks/axis/pdf.py)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#icici-banksicicipdfpy" class="md-nav__link">
<span class="md-ellipsis">
Icici (banks/icici/pdf.py)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#redundancy-rule-applied-in-both-banks" class="md-nav__link">
<span class="md-ellipsis">
Redundancy rule (applied in both banks)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#container-buildcls-in-hexacontainerpy" class="md-nav__link">
<span class="md-ellipsis">
Container (build(cls) in hexa/container.py)
</span>
</a>
<nav class="md-nav" aria-label="Container (build(cls) in hexa/container.py)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#control-flow-at-runtime-target" class="md-nav__link">
<span class="md-ellipsis">
Control flow at runtime (target)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#utilities-optional-hexa-agnostic" class="md-nav__link">
<span class="md-ellipsis">
Utilities (optional, hexa-agnostic)
</span>
</a>
<nav class="md-nav" aria-label="Utilities (optional, hexa-agnostic)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#shared-model" class="md-nav__link">
<span class="md-ellipsis">
Shared model
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#1-parse_yamlpath-portnode" class="md-nav__link">
<span class="md-ellipsis">
1. parse_yaml(path) -&gt; PortNode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-generate_abcpath_yaml-out_pathnone-str" class="md-nav__link">
<span class="md-ellipsis">
2. generate_abc(path_yaml, out_path=None) -&gt; str
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-parse_abcmodule_or_path-portnode" class="md-nav__link">
<span class="md-ellipsis">
3. parse_abc(module_or_path) -&gt; PortNode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-generate_yamlmodule_or_path-out_pathnone-str" class="md-nav__link">
<span class="md-ellipsis">
4. generate_yaml(module_or_path, out_path=None) -&gt; str
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-check_matchespath_a-path_b-bool" class="md-nav__link">
<span class="md-ellipsis">
5. check_matches(path_a, path_b) -&gt; bool
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#workflows-users-choice" class="md-nav__link">
<span class="md-ellipsis">
Workflows (user's choice)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -585,10 +264,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
@@ -601,8 +280,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -664,10 +343,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -680,8 +359,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -745,10 +424,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -761,8 +440,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -849,10 +528,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -865,8 +544,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -951,10 +630,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -967,8 +646,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -1030,10 +709,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -1046,8 +725,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>