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

updated doc forge docs
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-03-07 16:24:14 +05:30
parent 91baa41bee
commit 8701bf92ac
26 changed files with 7831 additions and 8208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

977
libs/doc-forge/site/nav/index.html
View File

File diff suppressed because it is too large Load Diff

541
libs/doc-forge/site/nav/mkdocs/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -151,12 +153,19 @@
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
@@ -182,136 +191,6 @@
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item">
<a href="../../models/" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item">
<a href="../../renderers/" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -325,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -371,13 +248,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -386,8 +273,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../loaders/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -396,8 +284,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
@@ -407,27 +301,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
@@ -467,13 +340,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -482,8 +369,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../models/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -492,8 +380,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
@@ -503,27 +397,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../models/" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -610,6 +483,18 @@
@@ -617,7 +502,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -627,8 +511,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -637,8 +522,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
@@ -648,27 +539,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
@@ -783,6 +653,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs.MkDocsNavEmitter" class="md-nav__link">
<span class="md-ellipsis">
MkDocsNavEmitter
@@ -793,6 +673,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs.MkDocsNavEmitter-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs.MkDocsNavEmitter.emit" class="md-nav__link">
<span class="md-ellipsis">
emit
@@ -809,6 +699,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -835,13 +735,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -850,8 +764,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../renderers/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -860,8 +775,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
@@ -871,27 +792,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../renderers/" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
@@ -977,13 +877,29 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -992,8 +908,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../cli/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -1002,8 +919,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
@@ -1013,27 +936,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
@@ -1171,6 +1073,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs.MkDocsNavEmitter" class="md-nav__link">
<span class="md-ellipsis">
MkDocsNavEmitter
@@ -1181,6 +1093,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs.MkDocsNavEmitter-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.mkdocs.MkDocsNavEmitter.emit" class="md-nav__link">
<span class="md-ellipsis">
emit
@@ -1197,6 +1119,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1223,16 +1155,17 @@
<h2 id="docforge.nav.mkdocs" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge.nav.mkdocs</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">docforge.nav.mkdocs</span>
</h2>
<div class="doc doc-contents first">
<p>This module provides the MkDocsNavEmitter, which converts a ResolvedNav instance
into the specific YAML-ready list structure expected by the MkDocs 'nav'
configuration.</p>
<p>MkDocs navigation emitter.</p>
<p>This module provides the <code>MkDocsNavEmitter</code> class, which converts a
<code>ResolvedNav</code> instance into the navigation structure required by the
MkDocs <code>nav</code> configuration.</p>
@@ -1243,24 +1176,25 @@ configuration.</p>
<h3 id="docforge.nav.mkdocs-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="docforge.nav.mkdocs.MkDocsNavEmitter" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">MkDocsNavEmitter</span>
<h4 id="docforge.nav.mkdocs.MkDocsNavEmitter" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">MkDocsNavEmitter</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p>Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible
navigation structure.</p>
<p>Emit MkDocs navigation structures from resolved navigation data.</p>
<p>The emitter transforms a <code>ResolvedNav</code> object into the YAML-compatible
list structure expected by the MkDocs <code>nav</code> configuration field.</p>
@@ -1273,22 +1207,22 @@ navigation structure.</p>
<h5 id="docforge.nav.mkdocs.MkDocsNavEmitter-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h4 id="docforge.nav.mkdocs.MkDocsNavEmitter.emit" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">emit</span>
<h6 id="docforge.nav.mkdocs.MkDocsNavEmitter.emit" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">emit</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">emit</span><span class="p">(</span><span class="n">nav</span><span class="p">:</span> <span class="n">ResolvedNav</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">emit</span><span class="p">(</span><span class="n">nav</span><span class="p">:</span> <span class="n">ResolvedNav</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Generate a list of navigation entries for mkdocs.yml.</p>
<p>Generate a navigation structure for <code>mkdocs.yml</code>.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1309,7 +1243,8 @@ navigation structure.</p>
</td>
<td>
<div class="doc-md-description">
<p>The resolved navigation data.</p>
<p>Resolved navigation data describing documentation groups
and their associated Markdown files.</p>
</div>
</td>
<td>
@@ -1335,7 +1270,27 @@ navigation structure.</p>
</td>
<td>
<div class="doc-md-description">
<p>A list of dictionary mappings representing the MkDocs navigation.</p>
<p>A list of dictionaries representing the MkDocs navigation layout.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code><span title="typing.List">List</span>[<span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]]</code>
</td>
<td>
<div class="doc-md-description">
<p>Each dictionary maps a navigation label to a page or a list of</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code><span title="typing.List">List</span>[<span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]]</code>
</td>
<td>
<div class="doc-md-description">
<p>pages.</p>
</div>
</td>
</tr>
@@ -1379,6 +1334,8 @@ navigation structure.</p>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
@@ -1416,7 +1373,7 @@ navigation structure.</p>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>

612
libs/doc-forge/site/nav/resolver/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -151,12 +153,19 @@
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
@@ -182,136 +191,6 @@
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item">
<a href="../../models/" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item">
<a href="../../renderers/" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -325,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -371,13 +248,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -386,8 +273,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../loaders/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -396,8 +284,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
@@ -407,27 +301,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
@@ -467,13 +340,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -482,8 +369,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../models/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -492,8 +380,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
@@ -503,27 +397,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../models/" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -610,6 +483,18 @@
@@ -617,7 +502,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -627,8 +511,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -637,8 +522,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
@@ -648,27 +539,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
@@ -760,6 +630,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.ResolvedNav" class="md-nav__link">
<span class="md-ellipsis">
ResolvedNav
@@ -770,6 +650,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.ResolvedNav-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.ResolvedNav.all_files" class="md-nav__link">
<span class="md-ellipsis">
all_files
@@ -783,6 +673,26 @@
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.nav.resolver-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.resolve_nav" class="md-nav__link">
<span class="md-ellipsis">
@@ -795,6 +705,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -844,13 +759,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -859,8 +788,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../renderers/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -869,8 +799,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
@@ -880,27 +816,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../renderers/" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
@@ -986,13 +901,29 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -1001,8 +932,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../cli/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -1011,8 +943,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
@@ -1022,27 +960,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
@@ -1180,6 +1097,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.ResolvedNav" class="md-nav__link">
<span class="md-ellipsis">
ResolvedNav
@@ -1190,6 +1117,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.ResolvedNav-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.ResolvedNav.all_files" class="md-nav__link">
<span class="md-ellipsis">
all_files
@@ -1203,6 +1140,26 @@
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.nav.resolver-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.nav.resolver.resolve_nav" class="md-nav__link">
<span class="md-ellipsis">
@@ -1215,6 +1172,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1241,16 +1203,16 @@
<h2 id="docforge.nav.resolver" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge.nav.resolver</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">docforge.nav.resolver</span>
</h2>
<div class="doc doc-contents first">
<p>This module contains the logic for resolving a NavSpec against the physical
filesystem. It expands globs and validates that all referenced documents
actually exist on disk.</p>
<p>Navigation resolution utilities.</p>
<p>This module resolves a <code>NavSpec</code> against the filesystem by expanding glob
patterns and validating that referenced documentation files exist.</p>
@@ -1261,25 +1223,26 @@ actually exist on disk.</p>
<h3 id="docforge.nav.resolver-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="docforge.nav.resolver.ResolvedNav" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">ResolvedNav</span>
<h4 id="docforge.nav.resolver.ResolvedNav" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ResolvedNav</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">ResolvedNav</span><span class="p">(</span><span class="n">home</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">Path</span><span class="p">]],</span> <span class="n">docs_root</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">ResolvedNav</span><span class="p">(</span><span class="n">home</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">Path</span><span class="p">]],</span> <span class="n">docs_root</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Represents a navigation structure where all patterns and paths have been
resolved against the actual filesystem contents.</p>
<p>Resolved navigation structure.</p>
<p>A <code>ResolvedNav</code> represents navigation data after glob patterns have been
expanded and paths validated against the filesystem.</p>
<p><span class="doc-section-title">Attributes:</span></p>
@@ -1299,7 +1262,7 @@ resolved against the actual filesystem contents.</p>
</td>
<td>
<div class="doc-md-description">
<p>Resolved relative path to the home page.</p>
<p>Relative path to the documentation home page.</p>
</div>
</td>
</tr>
@@ -1310,7 +1273,8 @@ resolved against the actual filesystem contents.</p>
</td>
<td>
<div class="doc-md-description">
<p>Mapping of group titles to lists of absolute or relative Path objects.</p>
<p>Mapping of navigation group titles to lists of resolved
documentation file paths.</p>
</div>
</td>
</tr>
@@ -1338,7 +1302,7 @@ resolved against the actual filesystem contents.</p>
</td>
<td>
<div class="doc-md-description">
<p>The relative path to the project home page.</p>
<p>Relative path to the home page within the documentation root.</p>
</div>
</td>
<td>
@@ -1352,7 +1316,7 @@ resolved against the actual filesystem contents.</p>
</td>
<td>
<div class="doc-md-description">
<p>A mapping of group names to their resolved filesystem paths.</p>
<p>Mapping of group titles to resolved documentation file paths.</p>
</div>
</td>
<td>
@@ -1366,7 +1330,7 @@ resolved against the actual filesystem contents.</p>
</td>
<td>
<div class="doc-md-description">
<p>The root documentation directory.</p>
<p>Root directory of the documentation source files.</p>
</div>
</td>
<td>
@@ -1387,22 +1351,22 @@ resolved against the actual filesystem contents.</p>
<h5 id="docforge.nav.resolver.ResolvedNav-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h4 id="docforge.nav.resolver.ResolvedNav.all_files" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">all_files</span>
<h6 id="docforge.nav.resolver.ResolvedNav.all_files" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">all_files</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">all_files</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">all_files</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Get an iterable of all resolved files in the navigation structure.</p>
<p>Iterate over all files referenced by the navigation structure.</p>
<p><span class="doc-section-title">Returns:</span></p>
@@ -1420,7 +1384,31 @@ resolved against the actual filesystem contents.</p>
</td>
<td>
<div class="doc-md-description">
<p>An iterable of Path objects.</p>
<p>An iterable of <code>Path</code> objects representing documentation files.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>RuntimeError</code>
</td>
<td>
<div class="doc-md-description">
<p>If the home page is defined but the documentation
root is not available for resolution.</p>
</div>
</td>
</tr>
@@ -1438,23 +1426,24 @@ resolved against the actual filesystem contents.</p>
</div>
</div>
<h3 id="docforge.nav.resolver-functions">Functions</h3>
<div class="doc doc-object doc-function">
<h3 id="docforge.nav.resolver.resolve_nav" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">resolve_nav</span>
<h4 id="docforge.nav.resolver.resolve_nav" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">resolve_nav</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">resolve_nav</span><span class="p">(</span><span class="n">spec</span><span class="p">:</span> <span class="n">NavSpec</span><span class="p">,</span> <span class="n">docs_root</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResolvedNav</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">resolve_nav</span><span class="p">(</span><span class="n">spec</span><span class="p">:</span> <span class="n">NavSpec</span><span class="p">,</span> <span class="n">docs_root</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResolvedNav</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Create a ResolvedNav by processing a NavSpec against the filesystem.
This expands globs and validates the existence of referenced files.</p>
<p>Resolve a navigation specification against the filesystem.</p>
<p>The function expands glob patterns defined in a <code>NavSpec</code> and verifies
that referenced documentation files exist within the documentation root.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1475,7 +1464,7 @@ This expands globs and validates the existence of referenced files.</p>
</td>
<td>
<div class="doc-md-description">
<p>The navigation specification to resolve.</p>
<p>Navigation specification describing documentation layout.</p>
</div>
</td>
<td>
@@ -1489,7 +1478,7 @@ This expands globs and validates the existence of referenced files.</p>
</td>
<td>
<div class="doc-md-description">
<p>The root directory for documentation files.</p>
<p>Root directory containing documentation Markdown files.</p>
</div>
</td>
<td>
@@ -1515,7 +1504,7 @@ This expands globs and validates the existence of referenced files.</p>
</td>
<td>
<div class="doc-md-description">
<p>A ResolvedNav instance.</p>
<p>A <code>ResolvedNav</code> instance containing validated navigation paths.</p>
</div>
</td>
</tr>
@@ -1538,7 +1527,8 @@ This expands globs and validates the existence of referenced files.</p>
</td>
<td>
<div class="doc-md-description">
<p>If a pattern doesn't match any files or the docs_root doesn't exist.</p>
<p>If the documentation root does not exist or a
navigation pattern does not match any files.</p>
</div>
</td>
</tr>
@@ -1573,6 +1563,8 @@ This expands globs and validates the existence of referenced files.</p>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
@@ -1610,7 +1602,7 @@ This expands globs and validates the existence of referenced files.</p>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>

646
libs/doc-forge/site/nav/spec/index.html
View File

File diff suppressed because it is too large Load Diff