arborist/docs/_source/_build/html/index.html
russell@unturf.com 49607a5997
docs: add Sphinx API reference generation from docstrings
Implements Read the Docs infrastructure to generate API documentation
directly from code docstrings. Replaces static modules.md (1200+ lines).

New structure:
- docs/_source/conf.py — Sphinx configuration (furo theme)
- docs/_source/index.rst — Main TOC
- docs/_source/api/*.rst — Module groups (substrate, storage, retrieval,
  qa, distill, mesh, cli)
- docs/_source/Makefile — Local build targets
- docs/_source/README.md — Documentation on building and extending

Makefile integration:
- make docs-api — generate HTML (output: docs/_source/_build/html/)
- make docs-api-clean — remove build artifacts

Build output (40 HTML files):
- API module reference with docstrings
- Source code links (:viewcode: extension)
- Full-text search index
- Module index (genindex, py-modindex)

Sphinx installed in venv as dev dependency. HTML is browseable at
docs/_source/_build/html/index.html (open in browser after build).

This justifies the deletion of modules.md: code docstrings + Sphinx
autodoc = automatically-generated, always-current API reference.
2026-05-04 07:55:34 -04:00

512 lines
No EOL
44 KiB
HTML

<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Substrate: Core data structures" href="api/substrate.html">
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
<title>Aborist API Reference</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
<style>
body {
--color-code-background: #f2f2f2;
--color-code-foreground: #1e1e1e;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</label>
</div>
<div class="header-center">
<a href="#"><div class="brand">Aborist API Reference</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><div class="sidebar-tree">
<p class="caption" role="heading"><span class="caption-text">API Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/substrate.html">Substrate: Core data structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/storage.html">Storage: SQLite schema and audit</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/retrieval.html">Retrieval: FTS5 search and concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/qa.html">Q&amp;A Pipeline: question → answer → verify → cache</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/distill.html">Distillation: surface → core compression</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/mesh.html">Federation: multiplayer aborist</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/cli.html">CLI: Command-line interface</a></li>
</ul>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="_sources/index.rst.txt" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div>
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="aborist-api-reference">
<h1>Aborist API Reference<a class="headerlink" href="#aborist-api-reference" title="Link to this heading"></a></h1>
<p>Generated from docstrings. Replaces the static modules.md.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/substrate.html">Substrate: Core data structures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/substrate.html#module-aborist.merkle">merkle</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.hash_leaf"><code class="docutils literal notranslate"><span class="pre">hash_leaf()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.hash_combine"><code class="docutils literal notranslate"><span class="pre">hash_combine()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.ProofNode"><code class="docutils literal notranslate"><span class="pre">ProofNode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.MerkleProof"><code class="docutils literal notranslate"><span class="pre">MerkleProof</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.MerkleTree"><code class="docutils literal notranslate"><span class="pre">MerkleTree</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.verify_proof"><code class="docutils literal notranslate"><span class="pre">verify_proof()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.proof_to_dict"><code class="docutils literal notranslate"><span class="pre">proof_to_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.merkle.proof_from_dict"><code class="docutils literal notranslate"><span class="pre">proof_from_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/substrate.html#module-aborist.document">document</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.Edge"><code class="docutils literal notranslate"><span class="pre">Edge</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.Document"><code class="docutils literal notranslate"><span class="pre">Document</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.canonicalize"><code class="docutils literal notranslate"><span class="pre">canonicalize()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.Chunker"><code class="docutils literal notranslate"><span class="pre">Chunker</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.TokenChunker"><code class="docutils literal notranslate"><span class="pre">TokenChunker</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.SentenceChunker"><code class="docutils literal notranslate"><span class="pre">SentenceChunker</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.document.get_chunker"><code class="docutils literal notranslate"><span class="pre">get_chunker()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/substrate.html#module-aborist.wikitext">wikitext</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#versioning-protocol">Versioning protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#algorithm-wikitext-base-v1">Algorithm (wikitext-base-v1)</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.wikitext.to_base"><code class="docutils literal notranslate"><span class="pre">to_base()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/substrate.html#aborist.wikitext.extract_wikilinks"><code class="docutils literal notranslate"><span class="pre">extract_wikilinks()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/storage.html">Storage: SQLite schema and audit</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/storage.html#module-aborist.store">store</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.connect"><code class="docutils literal notranslate"><span class="pre">connect()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.discover_shards"><code class="docutils literal notranslate"><span class="pre">discover_shards()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.connect_query"><code class="docutils literal notranslate"><span class="pre">connect_query()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.transaction"><code class="docutils literal notranslate"><span class="pre">transaction()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.get_meta"><code class="docutils literal notranslate"><span class="pre">get_meta()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.set_meta"><code class="docutils literal notranslate"><span class="pre">set_meta()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.latest_event_hash"><code class="docutils literal notranslate"><span class="pre">latest_event_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.chain_audit_events"><code class="docutils literal notranslate"><span class="pre">chain_audit_events()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.append_audit"><code class="docutils literal notranslate"><span class="pre">append_audit()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.store.stats"><code class="docutils literal notranslate"><span class="pre">stats()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/storage.html#module-aborist.ingest">ingest</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.ingest.IngestStats"><code class="docutils literal notranslate"><span class="pre">IngestStats</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.ingest.ingest_source"><code class="docutils literal notranslate"><span class="pre">ingest_source()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.ingest.verify_random_sample"><code class="docutils literal notranslate"><span class="pre">verify_random_sample()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/storage.html#module-aborist.evict">evict</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.evict.evict_to_cold"><code class="docutils literal notranslate"><span class="pre">evict_to_cold()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/storage.html#aborist.evict.rehydrate"><code class="docutils literal notranslate"><span class="pre">rehydrate()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/retrieval.html">Retrieval: FTS5 search and concepts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/retrieval.html#module-aborist.search">search</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.search.AuditMode"><code class="docutils literal notranslate"><span class="pre">AuditMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.search.Hit"><code class="docutils literal notranslate"><span class="pre">Hit</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.search.SearchBackend"><code class="docutils literal notranslate"><span class="pre">SearchBackend</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.search.FTS5Backend"><code class="docutils literal notranslate"><span class="pre">FTS5Backend</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/retrieval.html#module-aborist.source">sources</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.source.Source"><code class="docutils literal notranslate"><span class="pre">Source</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.sources.wikipedia.WikipediaSqlDump"><code class="docutils literal notranslate"><span class="pre">WikipediaSqlDump</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.sources.wikipedia.WikipediaCurDump"><code class="docutils literal notranslate"><span class="pre">WikipediaCurDump</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.sources.wikipedia.WikipediaOldDump"><code class="docutils literal notranslate"><span class="pre">WikipediaOldDump</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.sources.html_page.parse_html"><code class="docutils literal notranslate"><span class="pre">parse_html()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.sources.html_page.HtmlPageSource"><code class="docutils literal notranslate"><span class="pre">HtmlPageSource</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/retrieval.html#module-aborist.concepts">concepts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.add_concept_relation"><code class="docutils literal notranslate"><span class="pre">add_concept_relation()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.concept_relations_for_token"><code class="docutils literal notranslate"><span class="pre">concept_relations_for_token()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.has_compare_phrasing"><code class="docutils literal notranslate"><span class="pre">has_compare_phrasing()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.invalidate_cache"><code class="docutils literal notranslate"><span class="pre">invalidate_cache()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.purge_by_evidence_kind"><code class="docutils literal notranslate"><span class="pre">purge_by_evidence_kind()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.rivalry_excluded"><code class="docutils literal notranslate"><span class="pre">rivalry_excluded()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/retrieval.html#aborist.concepts.synonym_expand"><code class="docutils literal notranslate"><span class="pre">synonym_expand()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/qa.html">Q&amp;A Pipeline: question → answer → verify → cache</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.keys">keys</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.canonical_question"><code class="docutils literal notranslate"><span class="pre">canonical_question()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.question_hash"><code class="docutils literal notranslate"><span class="pre">question_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.model_profile_hash"><code class="docutils literal notranslate"><span class="pre">model_profile_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.conversation_hash"><code class="docutils literal notranslate"><span class="pre">conversation_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.governance_policy_hash"><code class="docutils literal notranslate"><span class="pre">governance_policy_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.verifier_policy_hash"><code class="docutils literal notranslate"><span class="pre">verifier_policy_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.keys.cache_key"><code class="docutils literal notranslate"><span class="pre">cache_key()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.runner">runner</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.runner.ask"><code class="docutils literal notranslate"><span class="pre">ask()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.query">query</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.query.query"><code class="docutils literal notranslate"><span class="pre">query()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.verify">verify</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.extract_quotes"><code class="docutils literal notranslate"><span class="pre">extract_quotes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.extract_claim_spans"><code class="docutils literal notranslate"><span class="pre">extract_claim_spans()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.extract_proper_nouns"><code class="docutils literal notranslate"><span class="pre">extract_proper_nouns()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.verify_quotes"><code class="docutils literal notranslate"><span class="pre">verify_quotes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.verify_claim_lattice"><code class="docutils literal notranslate"><span class="pre">verify_claim_lattice()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.evidence_map_by_evidence_id_local"><code class="docutils literal notranslate"><span class="pre">evidence_map_by_evidence_id_local()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.verify.verify_claim_lattice_json"><code class="docutils literal notranslate"><span class="pre">verify_claim_lattice_json()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.evidence">evidence</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.EvidenceObject"><code class="docutils literal notranslate"><span class="pre">EvidenceObject</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.build_evidence_map"><code class="docutils literal notranslate"><span class="pre">build_evidence_map()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.evidence_map_root"><code class="docutils literal notranslate"><span class="pre">evidence_map_root()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.render_evidence_block"><code class="docutils literal notranslate"><span class="pre">render_evidence_block()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.render_evidence_map"><code class="docutils literal notranslate"><span class="pre">render_evidence_map()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.render_evidence_block_for_json"><code class="docutils literal notranslate"><span class="pre">render_evidence_block_for_json()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.render_evidence_map_for_json"><code class="docutils literal notranslate"><span class="pre">render_evidence_map_for_json()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.evidence_map_by_pointer_id"><code class="docutils literal notranslate"><span class="pre">evidence_map_by_pointer_id()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.evidence_map_by_evidence_id"><code class="docutils literal notranslate"><span class="pre">evidence_map_by_evidence_id()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.evidence.render_claim_lattice"><code class="docutils literal notranslate"><span class="pre">render_claim_lattice()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.quantifier">quantifier</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.quantifier.classify_question_quantifier"><code class="docutils literal notranslate"><span class="pre">classify_question_quantifier()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.metacognition">metacognition</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.metacognition.QuestionState"><code class="docutils literal notranslate"><span class="pre">QuestionState</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.metacognition.detect_temporal_sensitivity"><code class="docutils literal notranslate"><span class="pre">detect_temporal_sensitivity()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.metacognition.detect_contradiction"><code class="docutils literal notranslate"><span class="pre">detect_contradiction()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.metacognition.detect_false_premise"><code class="docutils literal notranslate"><span class="pre">detect_false_premise()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.metacognition.detect_out_of_corpus"><code class="docutils literal notranslate"><span class="pre">detect_out_of_corpus()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.metacognition.preflight_question"><code class="docutils literal notranslate"><span class="pre">preflight_question()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.dag">dag</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.dag.localize_failure"><code class="docutils literal notranslate"><span class="pre">localize_failure()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.dag.build_preflight_node_payload"><code class="docutils literal notranslate"><span class="pre">build_preflight_node_payload()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.dag.preflight_node_hash"><code class="docutils literal notranslate"><span class="pre">preflight_node_hash()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.dag.build_run_dag"><code class="docutils literal notranslate"><span class="pre">build_run_dag()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.dag.build_reject_run_dag"><code class="docutils literal notranslate"><span class="pre">build_reject_run_dag()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.dag.verify_run_dag"><code class="docutils literal notranslate"><span class="pre">verify_run_dag()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/qa.html#module-aborist.qa.client">client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.client.ChatClient"><code class="docutils literal notranslate"><span class="pre">ChatClient</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.client.StubClient"><code class="docutils literal notranslate"><span class="pre">StubClient</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/qa.html#aborist.qa.client.OpenAICompatibleClient"><code class="docutils literal notranslate"><span class="pre">OpenAICompatibleClient</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/distill.html">Distillation: surface → core compression</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/distill.html#aborist.distill.DistillationResult"><code class="docutils literal notranslate"><span class="pre">DistillationResult</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.DistillationResult.core"><code class="docutils literal notranslate"><span class="pre">DistillationResult.core</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.DistillationResult.contributing_chunk_indices"><code class="docutils literal notranslate"><span class="pre">DistillationResult.contributing_chunk_indices</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/distill.html#aborist.distill.Distiller"><code class="docutils literal notranslate"><span class="pre">Distiller</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.Distiller.name"><code class="docutils literal notranslate"><span class="pre">Distiller.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.Distiller.distill"><code class="docutils literal notranslate"><span class="pre">Distiller.distill()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/distill.html#aborist.distill.FirstSentenceDistiller"><code class="docutils literal notranslate"><span class="pre">FirstSentenceDistiller</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.FirstSentenceDistiller.name"><code class="docutils literal notranslate"><span class="pre">FirstSentenceDistiller.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.FirstSentenceDistiller.distill"><code class="docutils literal notranslate"><span class="pre">FirstSentenceDistiller.distill()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/distill.html#aborist.distill.TfidfKeywordDistiller"><code class="docutils literal notranslate"><span class="pre">TfidfKeywordDistiller</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.TfidfKeywordDistiller.name"><code class="docutils literal notranslate"><span class="pre">TfidfKeywordDistiller.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/distill.html#aborist.distill.TfidfKeywordDistiller.distill"><code class="docutils literal notranslate"><span class="pre">TfidfKeywordDistiller.distill()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/mesh.html">Federation: multiplayer aborist</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity"><code class="docutils literal notranslate"><span class="pre">MeshIdentity</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.member_id"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.member_id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.sign_priv"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.sign_priv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.sign_pub"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.sign_pub</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.dh_priv"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.dh_priv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.dh_pub"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.dh_pub</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.group_name"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.group_name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshIdentity.created_at"><code class="docutils literal notranslate"><span class="pre">MeshIdentity.created_at</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshRosterEntry"><code class="docutils literal notranslate"><span class="pre">MeshRosterEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshRosterEntry.member_id"><code class="docutils literal notranslate"><span class="pre">MeshRosterEntry.member_id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshRosterEntry.sign_pub"><code class="docutils literal notranslate"><span class="pre">MeshRosterEntry.sign_pub</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshRosterEntry.dh_pub"><code class="docutils literal notranslate"><span class="pre">MeshRosterEntry.dh_pub</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/mesh.html#aborist.mesh.MeshRosterEntry.role"><code class="docutils literal notranslate"><span class="pre">MeshRosterEntry.role</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.aead_decrypt"><code class="docutils literal notranslate"><span class="pre">aead_decrypt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.aead_encrypt"><code class="docutils literal notranslate"><span class="pre">aead_encrypt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.current_epoch"><code class="docutils literal notranslate"><span class="pre">current_epoch()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.ecdh_shared_secret"><code class="docutils literal notranslate"><span class="pre">ecdh_shared_secret()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.generate_dh_keypair"><code class="docutils literal notranslate"><span class="pre">generate_dh_keypair()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.generate_signing_keypair"><code class="docutils literal notranslate"><span class="pre">generate_signing_keypair()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.init_identity"><code class="docutils literal notranslate"><span class="pre">init_identity()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.is_enabled"><code class="docutils literal notranslate"><span class="pre">is_enabled()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.load_identity"><code class="docutils literal notranslate"><span class="pre">load_identity()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.set_enabled"><code class="docutils literal notranslate"><span class="pre">set_enabled()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.sign"><code class="docutils literal notranslate"><span class="pre">sign()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mesh.html#aborist.mesh.verify"><code class="docutils literal notranslate"><span class="pre">verify()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/cli.html">CLI: Command-line interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/cli.html#aborist.cli.build_parser"><code class="docutils literal notranslate"><span class="pre">build_parser()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cli.html#aborist.cli.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="api/substrate.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Substrate: Core data structures</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2026, agent blackops
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer no-toc">
</aside>
</div>
</div><script src="_static/documentation_options.js?v=335b8a46"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
</body>
</html>